如何使用 Node.js 和 Express 创建 REST API

什么是 REST API？

REST API 是一种架构风格，它使用 HTTP 协议来促进客户端和服务器应用程序之间的数据交换。该架构围绕一系列约束和原则设计，包括统一的接口、无状态通信以及使用标准 HTTP 方法（例如 GET、POST、PUT、DELETE）来对资源执行操作。.

关键 REST API 概念

资源：
资源是 REST 中的基本单元。每个资源都由一个 URL（唯一地址）标识。例如，在用于管理图书的 REST API 中，一本书可以是一个位于以下位置的资源： /books/1 可用的。.
HTTP 方法：
REST API 使用标准 HTTP 方法与资源进行交互：
- 得到： 从服务器检索数据（例如，获取书籍列表或特定书籍）。.
- 邮政： 向服务器发送数据以创建新资源（例如，添加新书）。.
- 放：使用新数据更新现有资源（例如，更新现有书籍的详细信息）。.
- 删除： 从服务器中删除资源（例如，删除一本书）。.
无国籍状态：
客户端向服务器发出的每个请求都必须包含服务器完成该请求所需的所有信息。服务器不会在请求之间存储任何关于客户端会话的状态或信息。这一特性使得 REST API 具有可扩展性和易于维护的特点。.
表现形式：
资源可以采用多种格式表示，例如 JSON、XML 或纯文本。JSON 是最常用的格式，因为它轻量级且易于使用。.
统一接口：
REST API 旨在提供统一的接口，以便以一致的方式与资源进行交互。这包括：
- 资源标识：URL 用于唯一标识资源。.
- 通过视图操作资源：客户端使用视图与资源进行交互（例如，发送 JSON 数据来创建或更新资源）。.
- 自描述消息：每条消息都包含足够的信息来描述其处理方式。.
- 超媒体作为应用程序状态引擎（HATEOAS）：客户端完全通过服务器动态提供的超链接与资源进行交互。.
客户端-服务器架构：
REST 将客户端和服务器分离，使它们能够独立发展。.
缓存能力：
REST API 的响应可以显式标记为可缓存或不可缓存。此功能允许客户端缓存响应，从而提高性能并减少重复请求的需要。.

REST API 的实际示例

以下是一个库的 REST API 端点示例：

1. 获取所有书籍的列表

地址： /图书

HTTP 方法： 得到

[
{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1949
},
{
"id": 2,
"title": "To Kill a Mockingbird",
"author": "Harper Lee",
"published_year": 1960
}
]

2. 获取特定书籍的详细信息

地址： /books/{id}

HTTP 方法： 得到

{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1949
}

3. 添加一本新书

地址： /图书

HTTP 方法： 邮政

要求：

POST /books Content-Type: application/json

{
"title": "Brave New World",
"author": "Aldous Huxley",
"published_year": 1932
}

回答：

{
"id": 3,
"title": "Brave New World",
"author": "Aldous Huxley",
"published_year": 1932
}

4. 更新现有书籍

地址： /books/{id}

HTTP 方法： 放

要求：

PUT /books/1 Content-Type: application/json

PUT /books/1
Content-Type: application/json
{
"title": "1984",
"author": "George Orwell",
"published_year": 1948
}

回答：

{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1948
}

什么是Node.js？

Node.js 是一个服务器端 JavaScript 运行时环境，它与流行的 Express 框架结合使用，可以高效、强大地构建 REST API。本文将通过实际示例，一步步引导您使用 Node.js 和 Express 创建 REST API。.

为什么使用Node.js和Express来构建REST API？

高性能和可扩展性： Node.js 基于谷歌的 V8 引擎构建，该引擎直接将 JavaScript 编译成机器代码，从而实现高速和高性能。Node.js 的非阻塞 I/O 模型能够高效地处理大量并发连接。.
JavaScript 无处不在： Node.js 允许开发者使用 JavaScript 进行客户端和服务器端开发，这使得学习更容易，并简化了开发流程。.
快速开发周期： 将 Node.js 与 Express 结合使用，可以实现快速的应用程序开发。Express 是一个简洁而灵活的框架，为 Web 和移动应用程序提供了一套强大的功能集。.
广泛的生态系统： Node.js 通过 npm 提供了丰富的库和模块，有助于加快开发速度。.
实时功能： Node.js 非常擅长构建实时应用程序，例如聊天和实时更新。.

使用 Node.js 构建 REST API 的分步指南

第一步：创建项目

首先，为你的项目创建一个新目录，并使用 npm 对其进行初始化：

mkdir my-rest-api
cd my-rest-api
npm init -y

步骤 2：安装依赖项

安装以下几个软件包，即可启动并运行您的 REST API：

表达： 基于Node.js的Web应用程序框架。.
正文解析器： 用于解析传入请求体的中间件。.
Nodemon（可选）： 一个用于在开发过程中自动重启服务器的工具。.

npm install express body-parser
npm install --save-dev nodemon

步骤 3：创建 Express 应用

创建一个 Express 应用程序并设置一个基本服务器：

const express = require('express');
const bodyParser = require('body-parser');
const app = express();
app.use(bodyParser.json());
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});

步骤 4：定义路由

路由定义了 API 端点。例如，GET 请求的路由：

app.get('/api/hello', (req, res) => {
res.json({ message: 'Hello, World!' });
});

步骤 5：实现 API

使用Nodemon或Node.js运行您的API：

npm start

如果 http://localhost:3000/api/hello 打开它，你会看到“Hello world!”这条消息。.

步骤 6：添加更多路线

要构建一个实用的 API，你需要定义更多路由并对资源实现 CRUD（创建、读取、更新、删除）操作。例如，一个简单的待办事项列表 API：

let todos = [];
app.get('/api/todos', (req, res) => {
res.json(todos);
});
app.post('/api/todos', (req, res) => {
const newTodo = req.body;
todos.push(newTodo);
res.status(201).json(newTodo);
});
// Implement PUT and DELETE as an exercise

本示例定义了用于列出和创建新任务的路径。您可以实现以下方法： 放 和 删除 展开即可更新和删除任务。.

步骤 7：API 测试

测试 API 以确保其正常运行至关重要。诸如此类的工具：邮差或者 艾比狗 他们可以帮助您提交请求和审核回复。.

步骤 8：部署 API

当您准备好与他人共享您的 API 时，您可以将其部署在 Heroku、AWS 或 Azure 等平台上。.

使用 Apidog 创建 REST API 的另一种方法

Apidog 简化了 REST API 开发流程，并提供测试、文档、安全和性能优化等功能。以下是使用 Apidog 的步骤：

步骤 1：下载并安装 Apidog

首先，您需要在Apidog上创建一个账户。您可以通过Apidog网站点击“注册”按钮来完成此操作。.

步骤 2：创建 API

在项目内部，您可以创建一个新的 API。文档就像一张 API 的地图，描述了它的资源、操作和参数。.

步骤 3：设置 REST API 参数

填写HTTP方法、请求/响应模型、查询参数、标头等。.

步骤 4：测试 REST API

API开发完成后，您可以点击“提交”按钮进行测试。.

关于 Node.js 中 REST API 的常见问题

1. 在Node.js中，哪个框架最适合构建REST API？

虽然 Feathers、Nest、LoopBack 和 Molecule 都是很棒的框架，但 Express 之所以成为最佳选择，原因如下：

完整功能： Express 提供 MVC 架构、强大的路由功能和内置中间件等特性。.
强大的社区支持： 它拥有庞大的用户群体，可以帮助你更快、更高效地工作。.
方便使用的： Express 的设置、学习和使用都很简单，因此非常适合初学者。.

2. REST API 应该使用 Go 还是 Node.js？

选择 Go 还是 Node.js 取决于多种因素，例如性能要求、开发速度以及团队的专业水平。.

Go 语言适用的场景：

你需要高性能和高效率。.
您的应用程序需要管理大量并发操作。.
你更喜欢文字表达。.

何时使用Node.js：

你需要快速的开发周期。.
您的应用程序是 I/O 驱动型的。.
整个项目都使用了 JavaScript。.

3. Node.js 适合 API 开发吗？

是的，Node.js 非常适合构建 RESTful API，因为它具有非阻塞架构和 Express 等工具。.

4. 实现 REST API 的最佳语言是什么？

实现 REST API 的最佳语言取决于项目的具体需求、开发团队的专业水平以及当前的技术栈。.

用于快速原型制作： Python（使用 Flask 或 Django 框架）或 Ruby（使用 Rails 框架）。.
为了获得高性能： Go 或 C#（与 ASP.NET Core）。.
为了建立强大的生态系统和社区支持： JavaScript（使用 Node.js）或 PHP。.
适用于企业级应用： Java 或 C#。.

5. Node.js 是否使用 REST API？

Node.js 本身是一个服务器端 JavaScript 运行时环境，并不内置 REST API 功能。然而，由于其非阻塞架构以及 Express.js 等框架的存在，Node.js 被广泛用于构建 REST API。.

6. 现在还有人使用 Express 吗？

是的，Express.js 仍然广泛用于开发 REST API 和 Web 应用程序。.

7. Next.js 可以替代 Express 吗？

Next.js 和 Express 是 Web 开发生态系统中用途不同的工具，二者不可替代。Next.js 更常用于服务器端渲染和构建 React 应用，而 Express 更适合管理路由和构建 RESTful API。.

8. Node.js 适合 API 开发吗？

是的，Node.js 非常适合 API 开发，因为它具有非阻塞架构，并且能够处理大量并发连接。此外，借助 Express.js 等框架，使用 Node.js 构建 RESTful API 也变得轻松快捷。.

9. 对于Node.js API来说，最好的数据库是什么？

最适合Node.js API的数据库取决于您的项目的具体需求：

MongoDB： 为了便于与Node.js集成，具有灵活性。.
PostgreSQL 和 MySQL： 为了实现强大的兼容性和 SQL 功能。.
SQLite： 适用于简单应用或嵌入式应用。.

评估您的应用需求并选择合适的数据库将有助于确保您的项目取得成功。.

结果

使用 Node.js 和 Express 构建 REST API 对任何 Web 开发人员来说都是一项强大的技能。本文涵盖了从项目设置到定义路由，再到测试和部署的主要步骤。记住，实践是成功的关键，所以不要害怕构建自己的 API 并尝试不同的功能。有了这些基础，你就能更好地开发具有 RESTful API 的强大且可扩展的 Web 应用程序。.