请解释在 Express 中如何设计 RESTful API 的路由？

推荐答案

在 Express 中设计 RESTful API 的路由时，通常遵循以下步骤：

1. 定义资源路径：根据 RESTful 设计原则，每个资源对应一个唯一的 URL 路径。例如，/users 表示用户资源，/posts 表示帖子资源。

2. 使用 HTTP 方法：RESTful API 使用 HTTP 方法来定义对资源的操作。常见的 HTTP 方法包括：

   • GET：获取资源
   • POST：创建资源
   • PUT：更新资源
   • DELETE：删除资源

3. 使用 Express Router：Express 提供了 express.Router() 来创建模块化的路由处理程序。可以将相关的路由组织在一起，便于维护。

4. 处理请求和响应：在每个路由处理函数中，使用 req 和 res 对象来处理请求和发送响应。

5. 中间件：可以使用中间件来处理请求前的逻辑，如身份验证、日志记录等。

以下是一个简单的示例：

// www.javascriptcn.com code example
const express = require('express');
const router = express.Router();

// 获取所有用户
router.get('/users', (req, res) => {
  res.send('Get all users');
});

// 创建新用户
router.post('/users', (req, res) => {
  res.send('Create a new user');
});

// 获取单个用户
router.get('/users/:id', (req, res) => {
  res.send(`Get user with ID ${req.params.id}`);
});

// 更新用户
router.put('/users/:id', (req, res) => {
  res.send(`Update user with ID ${req.params.id}`);
});

// 删除用户
router.delete('/users/:id', (req, res) => {
  res.send(`Delete user with ID ${req.params.id}`);
});

module.exports = router;

本题详细解读

1. 定义资源路径

在 RESTful API 中，资源路径通常以复数形式表示，如 /users、/posts。路径的设计应尽量简洁且易于理解，避免嵌套过深。

2. 使用 HTTP 方法

RESTful API 的核心在于使用 HTTP 方法来定义对资源的操作。每个 HTTP 方法对应一种操作：

• GET：用于获取资源，通常是安全的（不修改资源状态）。
• POST：用于创建新资源，通常是非幂等的（多次调用会产生多个资源）。
• PUT：用于更新资源，通常是幂等的（多次调用结果相同）。
• DELETE：用于删除资源，通常是幂等的。

3. 使用 Express Router

express.Router() 是 Express 提供的一个功能强大的工具，用于创建模块化的路由处理程序。通过将相关的路由组织在一起，可以提高代码的可维护性和可读性。

4. 处理请求和响应

在 Express 中，每个路由处理函数都接收两个参数：req（请求对象）和 res（响应对象）。req 对象包含请求的相关信息，如请求参数、请求体等；res 对象用于发送响应，如返回数据、设置状态码等。

5. 中间件

中间件是 Express 中处理请求前逻辑的强大工具。可以在路由处理函数之前执行一些操作，如身份验证、日志记录、数据验证等。中间件可以通过 app.use() 或 router.use() 来注册。

通过以上步骤，可以在 Express 中设计出符合 RESTful 原则的 API 路由。