Готовы ли вы создать свой собственный RESTful API с помощью Node.js? Этот учебник идеально подходит для начинающих веб-разработчиков, которые хотят начать разработку API! Я проведу вас через каждый шаг, гарантируя, что вы сможете создать мощный и эффективный RESTful API с нуля. Давайте погрузимся!
Предпосылки
Прежде чем мы начнем, убедитесь, что в вашей системе установлено следующее:
- Node.js: Загрузите и установите его с официального сайта Node.js.
- npm (диспетчер пакетов Node): поставляется в комплекте с Node.js.
Настройка вашего проекта
Создайте новую папку для своего проекта и перейдите к ней с помощью терминала:
mkdir rest-api-tutorial cd rest-api-tutorial
Инициализируйте новый проект Node.js с помощью:
npm init -y
Эта команда создаст файл package.json
, в котором будут храниться зависимости и конфигурации вашего проекта.
Установка зависимостей
Мы будем использовать платформу Express.js для создания нашего RESTful API. Чтобы установить его, запустите:
npm install express --save
Эта команда устанавливает пакет Express.js и добавляет его в раздел dependencies
вашего файла package.json
.
Создание API
Создайте файл index.js
в каталоге вашего проекта:
touch index.js
Откройте файл index.js
и импортируйте необходимые зависимости:
const express = require('express');
Инициализируйте приложение и определите порт:
const app = express(); const PORT = process.env.PORT || 3000;
Используйте промежуточное ПО express.json()
для анализа запросов JSON:
app.use(express.json());
Создайте простое хранилище данных в памяти для демонстрационных целей:
const dataStore = [ { id: 1, name: 'John Doe' }, { id: 2, name: 'Jane Doe' }, ];
Определите маршруты для API:
- GET маршрут для получения всех пользователей:
app.get('/api/users', (req, res) => { res.json(dataStore); });
- Маршрут POST для создания нового пользователя. Мы используем тело нашего запроса для передачи имени пользователя:
app.post('/api/users', (req, res) => { const newUser = { id: dataStore.length + 1, name: req.body.name, }; dataStore.push(newUser); res.status(201).json(newUser); });
Запустите сервер:
app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
Ваш файл index.js
должен выглядеть так:
const express = require('express'); const dataStore = [ { id: 1, name: "John Doe" }, { id: 2, name: "Jane Doe" }, ]; const app = express(); const PORT = process.env.PORT || 3000; app.use(express.json()); app.get("/api/users", (req, res) => { res.json(dataStore); }); app.post("/api/users", (req, res) => { const newUser = { id: dataStore.length + 1, name: req.body.name, }; dataStore.push(newUser); res.status(201).json(newUser); }); app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
Запустить API
В вашем терминале запустите:
node index.js
Вы увидите это сообщение. Ваш API работает на http://localhost:3000
node index.js Server is running on port 3000
Теперь вы можете использовать такие инструменты, как Postman или curl, чтобы протестировать новый RESTful API.
Поздравляем!
Вы успешно создали RESTful API с помощью Node.js. Этот простой API позволяет извлекать и добавлять пользователей в хранилище данных в памяти. Следующим шагом будет заставить интерфейсное приложение взаимодействовать с нашим API.
Как младший веб-разработчик, у вас теперь есть основа для разработки API. Продолжайте использовать эти знания, изучайте более продвинутые концепции, такие как аутентификация, постоянное хранилище и обработка ошибок, и продолжайте оттачивать свои навыки, чтобы стать опытным разработчиком API.
Прочитайте эту статью, чтобы лучше понять структуру RESTful API и рекомендации. Это ценный ресурс, который поможет вам создавать четкие, согласованные и простые для понимания API, отвечающие потребностям ваших пользователей и коллег-разработчиков:
Если вам понравилась статья и вы хотите меня поддержать:
- ✌️Если вы планируете подписаться на Medium, пожалуйста, не стесняйтесь использовать эту ссылку. Вам ничего не будет стоить, а мне очень поможет
- 👏 Хлопайте в ладоши, чтобы эта статья попала в топ
- 🔔Подпишитесь на меня в Медиуме