RESTful API 是现代 Web 开发中最流行的 API 设计规范之一。它使得客户端能够通过 HTTP 请求来访问和修改服务器上的资源。Express.js 是 Node.js 上面最受欢迎的 web 框架之一。在本篇学习笔记中，我们将介绍如何使用 Express.js 创建 RESTful API。
什么是 RESTful API
RESTful API 是一种架构风格，它定义了一组规则来设计 Web 应用程序的 API 接口。这些规则包括用 URL 来表示资源，使用 HTTP 动词（如 GET、POST、PUT、DELETE 等）来操作资源，以及使用 JSON 或者 XML 来传输数据。
RESTful API 基于客户端-服务器的架构风格，它可以适配多种客户端和服务端环境，运行在 HTTP 协议之上，具有良好的可扩展性、可维护性、可测试性、易于理解和文档化等特性。
安装 Express.js
在开始之前，我们需要先安装 Node.js 和 npm。假设您已经安装好它们，我们可以打开终端并运行以下命令来创建一个新的 Node.js 项目，并在其中安装 Express.js：
mkdir my-app cd my-app npm init -y npm install express
创建简单的 RESTful API
我们将开始创建一个简单的 RESTful API，该 API 有以下端点：
| Endpoint | HTTP 方法 | 描述 |
|---|---|---|
| / | GET | 返回一条简单的欢迎消息 |
| /users | GET | 返回所有用户的列表 |
| /users | POST | 创建一个新的用户 |
| /users/:id | GET | 返回指定 ID 的用户 |
| /users/:id | PUT | 更新一个用户 |
| /users/:id | DELETE | 删除一个用户 |
首先，我们需要在项目根目录下创建一个名为 index.js 的文件，并将以下代码添加到文件中：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- --- - --------- ----- ---- - ---------------- -- ---- ------------ ----- ---- -- - ---------------- ------- ------ -- ---------------- -- -- - -------------------- ------- ------ --
这段代码创建了一个 Express 应用程序，并为其添加了一个简单的路由。当访问 / 端点时，应用程序将返回一条简单的欢迎消息。
接下来，我们需要创建一个用于保存用户的空数组。我们可以将以下代码添加到 index.js 文件中：
let users = []
现在，我们可以添加 /users 端点的路由和处理函数。将以下代码添加到 index.js 文件的底部：
-- -------------------- ---- ------- -- --------- ----------------- ----- ---- -- - ---------- ----- -- -- -- -------- ------------------ --------------- ----- ---- -- - ----- - ----- --- - - -------- ----- ---- - - --- ------------ - -- ----- --- - ---------------- ---------------------- ---- -- --
这段代码将创建一个 /users 端点，并将 GET 和 POST 请求映射到相应的路由处理函数。其中，GET 请求会返回一个包含所有用户的 JSON 对象，而 POST 请求则会从请求体中读取用户信息，将其存储到用户数组中，并在创建成功后返回 JSON 格式的用户信息。
现在，我们已经实现了 / 和 /users 端点。接下来，我们将实现其余的 /users/:id 端点，以便能够获取、更新和删除指定用户的信息。
-- -------------------- ---- -------
-- ---- -- ---
--------------------- ----- ---- -- -
----- - -- - - ----------
----- ---- - ------------ -- ---- --- -------------
-- ------- -
---------------------- -------- ------- --
- ---- -
---------- ---- --
-
--
-- ---- -- ---
--------------------- --------------- ----- ---- -- -
----- - -- - - ----------
----- - ----- --- - - --------
----- --------- - ----------------- -- ---- --- -------------
-- ---------- --- --- -
---------------------- -------- ------- --
- ---- -
---------------- - - --- ------------- ----- --- -
---------- ----- ---------------- --
-
--
-- ---- -- ---
------------------------ ----- ---- -- -
----- - -- - - ----------
----- --------- - ----------------- -- ---- --- -------------
-- ---------- --- --- -
---------------------- -------- ------- --
- ---- -
----------------------- --
---------- -------- -------- --
-
--这段代码将创建 /users/:id 端点，并将 GET、PUT 和 DELETE 请求映射到相应的路由处理函数中。其中，GET 请求会获取指定 ID 的用户信息，PUT 请求会更新指定 ID 的用户信息，DELETE 请求会删除指定 ID 的用户信息。
运行 RESTful API
现在，我们已经创建好了一个简单的 RESTful API，可以通过以下命令来运行它：
node index.js
它会在终端输出 服务已经在端口3000上启动！ 的信息，表示 API 已经在 localhost:3000 上运行了。
你可以在浏览器或者 Postman 中访问以下 URL 来测试 API：
GET http://localhost:3000/ GET http://localhost:3000/users POST http://localhost:3000/users GET http://localhost:3000/users/1 PUT http://localhost:3000/users/1 DELETE http://localhost:3000/users/1
总结
在本文中，我们学习了如何使用 Express.js 创建 RESTful API。我们首先了解了 RESTful API 的基本概念和设计规范，接着学习了如何使用 Express.js 创建简单的 RESTful API。我们使用了 GET、POST、PUT 和 DELETE 请求，以及 json() 中间件来处理 JSON 数据。通过这篇笔记，我们希望能够帮助初学者更好地理解和学习 RESTful API 的设计和开发。如果你还有任何问题或建议，请在评论区留言。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64cfa7a5b5eee0b5256d9b45