在现代 Web 开发中，RESTful API 已经成为了一种非常流行的 API 设计风格。它强调使用 HTTP 协议的各种方法（GET、POST、PUT、DELETE 等）来进行资源的 CRUD 操作，并且使用 URL 来表示资源的唯一标识符。在 Node.js 中，Express.js 框架是一个非常流行的构建 RESTful API 的工具，它提供了一些非常有用的功能和最佳实践，可以帮助我们快速构建出高质量的 API 服务。
安装和配置 Express.js
首先，我们需要安装 Express.js 框架。在终端中输入以下命令：
npm install express --save
接着，在项目中创建一个 app.js 文件，并在其中引入 Express.js：
const express = require('express');
const app = express();设计 RESTful API
在设计 RESTful API 时，我们需要考虑以下几个方面：
1. 资源的唯一标识符
每个资源都需要有一个唯一的标识符，通常使用 URL 来表示。例如，一个用户资源的 URL 可以是 /users/:id，其中 :id 表示用户的唯一标识符。在 Express.js 中，我们可以使用 req.params 来获取 URL 中的参数。
app.get('/users/:id', (req, res) => {
const userId = req.params.id;
// ...
});2. HTTP 方法的使用
RESTful API 强调使用 HTTP 协议的各种方法来进行资源的 CRUD 操作。在 Express.js 中，我们可以使用 app.get()、app.post()、app.put() 和 app.delete() 等方法来分别处理 HTTP 的 GET、POST、PUT 和 DELETE 请求。
-- -------------------- ---- ------- ----------------- ----- ---- -- - -- ------ --- ------------------ ----- ---- -- - -- ------- --- --------------------- ----- ---- -- - ----- ------ - -------------- -- --------- --- ------------------------ ----- ---- -- - ----- ------ - -------------- -- ------ ---
3. 数据格式的使用
RESTful API 通常使用 JSON 格式来传输数据。在 Express.js 中，我们可以使用 req.body 来获取 POST 或 PUT 请求中的数据，并使用 res.json() 来返回 JSON 格式的数据。
app.post('/users', (req, res) => {
const newUser = req.body;
// 创建一个新用户
res.json(newUser);
});最佳实践
除了上述的基本设计原则之外，还有一些最佳实践可以帮助我们构建出更加高效、健壮和可维护的 RESTful API：
1. 使用中间件
Express.js 中的中间件是一种非常强大的功能，它可以在请求到达处理程序之前或之后执行某些操作。我们可以使用中间件来验证请求、记录日志、解析请求体等等。例如，下面是一个使用中间件验证用户身份的示例：
-- -------------------- ---- ------- ----- -------------- - ----- ---- ----- -- - ----- ----- - -------------------------- -- ------ ------- -- ----------------- --------------- ----- ---- -- - -- ------ ---
2. 使用路由模块化
当我们的 API 服务变得越来越复杂时，我们需要考虑将路由模块化，以便更好地组织我们的代码。在 Express.js 中，我们可以使用 express.Router() 来创建一个路由器，并将其与应用程序的主要路由器组合起来。
-- -------------------- ---- ------- ----- ---------- - ----------------- ------------------- ----- ---- -- - -- ------ --- -------------------- ----- ---- -- - -- ------- --- ----------------- ------------
3. 使用数据库
在实际的应用程序中，我们通常需要将数据存储在数据库中，以便进行持久化存储和查询。在 Node.js 中，我们可以使用许多不同的数据库，例如 MongoDB、MySQL、PostgreSQL 等。在 Express.js 中，我们可以使用相应的数据库驱动程序来连接和操作数据库。
-- -------------------- ---- -------
----- ----------- - -------------------------------
----- --- - ----------------------------
----- ------ - ------------
------------------------ ----- ------- -- -
---------------------- ------------ -- ---------
----- -- - ------------------
----- ----- - -----------------------
----------------- ----- ---- -- -
---------------------------- ----- -- -
---------------
---
---
---示例代码
下面是一个完整的示例代码，它演示了如何使用 Express.js 框架构建一个简单的 RESTful API：
-- -------------------- ---- -------
----- ------- - -------------------
----- ---------- - -----------------------
----- ----------- - -------------------------------
----- --- - ----------
----- --- - ----------------------------
----- ------ - ------------
---------------------------
------------------------ ----- ------- -- -
---------------------- ------------ -- ---------
----- -- - ------------------
----- ----- - -----------------------
----------------- ----- ---- -- -
---------------------------- ----- -- -
---------------
---
---
--------------------- ----- ---- -- -
----- ------ - --------------
--------------- ---- ------ -- ----- ---- -- -
--------------
---
---
------------------ ----- ---- -- -
----- ------- - ---------
------------------------ ----- ------- -- -
------------------------
---
---
--------------------- ----- ---- -- -
----- ------ - --------------
----- ----------- - ---------
----------------- ---- ------ -- - ----- ----------- -- ----- ------- -- -
-----------------
---
---
------------------------ ----- ---- -- -
----- ------ - --------------
----------------- ---- ------ -- ----- ------- -- -
-----------------
---
---
---------------- -- -- -
---------------- --------- -- ---- --------
---
---结论
使用 Express.js 框架构建 RESTful API 是一种非常流行的方式，它可以帮助我们快速构建出高质量的 API 服务。在设计 API 时，我们需要考虑资源的唯一标识符、HTTP 方法的使用和数据格式的使用。除此之外，还有一些最佳实践可以帮助我们构建出更加高效、健壮和可维护的 API，例如使用中间件、使用路由模块化和使用数据库等等。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/675bc970a4d13391d8f83f11