REST (передача репрезентативного состояния) — это архитектурный стиль программного обеспечения для разработки взаимодействия веб-приложений. RESTful API — это API-интерфейс, основанный на архитектурном стиле REST, который использует стандартные методы HTTP (GET, POST, PUT, DELETE и т. д.) для работы и взаимодействия с ресурсами.
API, соответствующий принципам проектирования RESTful API, должен иметь следующие характеристики:
- Ресурсы : API организует данные и функции как набор ресурсов, каждый из которых имеет свой уникальный идентификатор (URI).
- Методы HTTP : API использует стандартные методы HTTP (GET, POST, PUT, DELETE и т. д.) для работы с ресурсами.
- Независимость от состояния : каждый запрос к API должен содержать достаточно информации, чтобы серверу не требовалось поддерживать какое-либо состояние клиента.
- Унифицированный интерфейс . API должен использовать унифицированную спецификацию интерфейса, включая унифицированные правила именования, формат возвращаемых данных и методы обработки ошибок.
Node.js предоставляет множество инструментов и модулей, которые позволяют нам легко создавать приложения, соответствующие дизайну RESTful API.
Установите и инициализируйте проект Node.js
Прежде чем мы начнем, нам нужно сначала установить Node.js. Вы можете посетить официальный сайт и следовать инструкциям, чтобы загрузить установочный пакет Node.js для вашей операционной системы, а затем установить его.
После завершения установки мы можем проверить, правильно ли установлен Node.js, с помощью следующей команды:
node -v
Далее мы создаем новый каталог и входим в него с помощью следующей команды:
mkdir restful-api
cd restful-api
Затем нам нужно инициализировать новый проект Node.js, выполнив следующую команду:
npm init -y
Это создаст новый package.jsonфайл в текущем каталоге для управления зависимостями проекта и информацией о конфигурации.
Установите и настройте фреймворк Express.
Express — это популярная веб-инфраструктура Node.js, которая предоставляет чистый и гибкий API для создания веб-приложений и RESTful API.
Чтобы установить и настроить платформу Express, нам нужно выполнить следующие команды:
npm install express
После завершения установки мы можем создать новый файл в корневом каталоге проекта index.jsи добавить следующий код:
const express = require('express');
const app = express();
const port = 3000;
app.get('/', (req, res) => {
res.send('Hello, World!');
});
app.listen(port, () => {
console.log(`Server is running at http://localhost:${
port}`);
});
В приведенном выше коде мы импортировали модуль Express и создали экземпляр приложения Express. Затем мы используем app.get()метод, чтобы указать /логику обработки корневого маршрута, и сервер вернется, когда будет запрос на доступ к корневому маршруту 'Hello, World!'.
Наконец, мы app.listen()запускаем сервер, вызывая метод, указав номер порта для прослушивания. В функции обратного вызова мы выводим сообщение об успешном запуске сервера.
Внедрить REST API
Ниже мы будем использовать платформу Express для реализации простого RESTful API. Предположим, мы создаем приложение для ведения блога и нам нужно реализовать следующие функции:
- Получить все статьи блога: GET /articles
- Создайте новый пост в блоге: POST /articles
- Получить конкретную запись в блоге: GET /articles/:id
- Чтобы обновить определенную запись в блоге: PUT /articles/:id
- Удалить определенную запись в блоге: DELETE /articles/:id
Сначала мы создаем новый файл routes/articles.jsи добавляем следующий код:
const express = require('express');
const router = express.Router();
// 获取所有博客文章
router.get('/', (req, res) => {
res.send('获取所有博客文章');
});
// 创建新的博客文章
router.post('/', (req, res) => {
res.send('创建新的博客文章');
});
// 获取特定博客文章
router.get('/:id', (req, res) => {
res.send(`获取特定博客文章，ID: ${
req.params.id}`);
});
// 更新特定博客文章
router.put('/:id', (req, res) => {
res.send(`更新特定博客文章，ID: ${
req.params.id}`);
});
// 删除特定博客文章
router.delete('/:id', (req, res) => {
res.send(`删除特定博客文章，ID: ${
req.params.id}`);
});
module.exports = router;
В приведенном выше коде мы создали articlesмодуль маршрутизации и определили функции обратного вызова, которые обрабатывают отдельные маршруты.
Далее нам нужно index.jsимпортировать articlesмодуль маршрутизации в файл. Модифицированный index.jsкод выглядит следующим образом:
const express = require('express');
const app = express();
const port = 3000;
const articlesRouter = require('./routes/articles');
app.use('/articles', articlesRouter);
app.listen(port, () => {
console.log(`Server is running at http://localhost:${
port}`);
});
В приведенном выше коде мы используем app.use()метод для регистрации articlesмодуля маршрутизации и указываем префикс как /articles. Это означает, что все /articlesзапросы, начинающиеся с, будут articlesобрабатываться модулем маршрутизации.
Теперь мы завершили простой RESTful API. Вы можете запустить сервер, выполнив:
node index.js
Затем вы можете использовать такие инструменты, как Postman, для тестирования отдельных маршрутов и функций API.
Подведем итог
В этой статье описывается, как создать RESTful API с помощью Node.js и платформы Express. Сначала мы узнали о концепциях и принципах RESTful API, затем установили и инициализировали проект Node.js, затем установили и настроили среду Express и реализовали простой RESTful API.
Надеюсь, эта статья поможет вам понять и освоить базовые знания и навыки работы с Node.js RESTful API. Благодаря разумному дизайну API и гибкому использованию среды Express вы сможете создавать высокопроизводительные, масштабируемые веб-приложения и API.