RESTful API 是一种基于 HTTP 协议的 API 设计风格，它以资源为中心，通过 HTTP 方法对资源进行操作，使得 API 更加灵活、易用、可扩展和易于维护。在 Express.js 中实现 RESTful API 可以让我们更加方便地构建 Web 应用程序，本文将介绍 RESTful API 的设计及实现方式。
RESTful API 的设计
RESTful API 的设计主要包括以下几个方面：
1. 资源的定义
在 RESTful API 中，资源是指 Web 应用程序中的数据或功能。资源应该以名词的形式来表示，比如用户、文章、评论等。
2. 路径的定义
在 RESTful API 中，路径是指资源的地址。路径应该以资源名为开头，以标识符为结尾，比如 /users/:id、/articles/:id/comments/:id 等。
3. HTTP 方法的定义
在 RESTful API 中，HTTP 方法是指对资源进行操作的方式。常用的 HTTP 方法有 GET、POST、PUT、PATCH 和 DELETE。
- GET：用于获取资源的信息。
- POST：用于创建新的资源。
- PUT：用于更新已有的资源。
- PATCH：用于更新已有的资源的部分内容。
- DELETE：用于删除资源。
4. 状态码的定义
在 RESTful API 中，状态码是指服务器响应的状态。常用的状态码有 200、201、204、400、401、403、404、500 等。
- 200：请求成功。
- 201：资源创建成功。
- 204：请求成功，但没有返回任何内容。
- 400：客户端请求错误。
- 401：未授权。
- 403：禁止访问。
- 404：资源不存在。
- 500：服务器错误。
RESTful API 的实现方式
在 Express.js 中实现 RESTful API 的方式主要有两种：基于路由和基于控制器。
1. 基于路由的实现方式
基于路由的实现方式是将路由和处理程序写在同一个文件中，比如 index.js。在 index.js 文件中，我们可以通过 app 对象来定义路由和处理程序。下面是一个基于路由的 RESTful API 的示例代码：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- -- ------ ----------------- ----- ---- -- - -- ----- --------- --- -- ------ --------------------- ----- ---- -- - -- ----- --------- --- -- ---- ------------------ ----- ---- -- - -- ----- ------- --- -- ---- --------------------- ----- ---- -- - -- ----- ------- --- -- ---- ------------------------ ----- ---- -- - -- ----- ------- --- ---------------- -- -- - ------------------- -- ------- -- ---- ------- ---
2. 基于控制器的实现方式
基于控制器的实现方式是将路由和处理程序分别写在不同的文件中。在控制器文件中，我们可以定义处理程序，并通过 module.exports 导出。在路由文件中，我们可以通过 require() 函数来引入控制器文件，并调用其导出的函数。下面是一个基于控制器的 RESTful API 的示例代码：
- userController.js
-- -------------------- ---- ------- ------------------- - ----- ---- -- - -- ----- --------- -- --------------------- - ----- ---- -- - -- ----- --------- -- ------------------ - ----- ---- -- - -- ----- ------- -- ------------------ - ----- ---- -- - -- ----- ------- -- ------------------ - ----- ---- -- - -- ----- ------- --
- userRoutes.js
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------ - ----------------- ----- -------------- - ---------------------------- -- ------ -------------------- ---------------------------- -- ------ ------------------------ ------------------------------ -- ---- --------------------- --------------------------- -- ---- ------------------------ --------------------------- -- ---- --------------------------- --------------------------- -------------- - -------
- index.js
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ---------- - ------------------------ ------------ ------------ ---------------- -- -- - ------------------- -- ------- -- ---- ------- ---
总结
本文介绍了在 Express.js 中实现 RESTful API 的设计及实现方式。在设计 RESTful API 时，需要定义资源、路径、HTTP 方法和状态码；在实现 RESTful API 时，可以采用基于路由和基于控制器的方式。希望本文能够对大家了解 RESTful API 的设计和实现方式有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/662662e3c9431a720c2d4615