RESTful API 是一种基于 HTTP 协议的 Web API 设计风格，它具有良好的可扩展性和可维护性，已经成为现代 Web 应用程序开发的标准之一。在本文中，我们将学习如何使用 Node.js 和 Express 框架来实现一个简单的 RESTful API 接口。
准备工作
在开始之前，我们需要安装 Node.js 和 Express 框架。可以从官方网站下载并安装 Node.js，然后使用以下命令来安装 Express 框架：
npm install express
设计 API 接口
在开始编写代码之前，我们需要先设计 API 接口。在本文中，我们将创建一个简单的 To-Do List 应用程序，它将具有以下 API 接口：
- GET /api/tasks：获取所有任务。
- POST /api/tasks：创建一个新的任务。
- GET /api/tasks/:id：获取具有给定 ID 的任务。
- PUT /api/tasks/:id：更新具有给定 ID 的任务。
- DELETE /api/tasks/:id：删除具有给定 ID 的任务。
编写代码
接下来，我们将编写代码来实现这些 API 接口。首先，我们需要创建一个 Express 应用程序并定义路由：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- --------------------- ----- ---- -- - -- ------ --- ---------------------- ----- ---- -- - -- -------- --- ------------------------- ----- ---- -- - -- ------ -- --- --- ------------------------- ----- ---- -- - -- ------ -- --- --- ---------------------------- ----- ---- -- - -- ------ -- --- --- ---------------- -- -- - ------------------- ------- -- ---- ------- ---
接下来，我们需要实现每个路由的处理程序。在本文中，我们将使用一个简单的 JavaScript 对象来存储所有任务。在实际应用程序中，您可能需要使用数据库或其他持久性存储。
-- -------------------- ---- -------
----- ----- - -
- --- -- ------ ----- --- ----- ----- --
- --- -- ------ ----- --- ----- ---- --
- --- -- ------ ----- --- ----- ----- -
--
--------------------- ----- ---- -- -
----------------
---
---------------------- ----- ---- -- -
----- ---- - -
--- ------------ - --
------ ---------------
----- -----
--
-----------------
---------------
---
------------------------- ----- ---- -- -
----- ---- - ------------ -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
---------------
---
------------------------- ----- ---- -- -
----- ---- - ------------ -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
---------- - ---------------
--------- - --------------
---------------
---
---------------------------- ----- ---- -- -
----- ---- - ------------ -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
----- ----- - --------------------
------------------- ---
---------------
---在上面的代码中，我们使用了 res.json() 方法来发送 JSON 格式的响应。我们还使用了 req.body 对象来访问 POST 和 PUT 请求的正文数据。在使用这些方法之前，我们需要在应用程序中添加以下代码来解析请求正文：
app.use(express.json());
app.use(express.urlencoded({ extended: true }));测试 API 接口
现在我们已经编写了所有必需的代码，我们可以使用 Postman 或类似的工具来测试 API 接口。在测试之前，请确保您的应用程序正在运行，并且正在监听端口 3000。
首先，让我们尝试获取所有任务。发送一个 GET 请求到 http://localhost:3000/api/tasks，并应该返回以下 JSON 响应：
[
{ "id": 1, "title": "Task 1", "done": false },
{ "id": 2, "title": "Task 2", "done": true },
{ "id": 3, "title": "Task 3", "done": false }
]接下来，让我们尝试创建一个新任务。发送一个 POST 请求到 http://localhost:3000/api/tasks，并在请求正文中包含以下 JSON 数据：
{
"title": "New task"
}应该返回以下 JSON 响应：
{
"id": 4,
"title": "New task",
"done": false
}接下来，让我们尝试获取一个具有给定 ID 的任务。发送一个 GET 请求到 http://localhost:3000/api/tasks/1，并应该返回以下 JSON 响应：
{
"id": 1,
"title": "Task 1",
"done": false
}接下来，让我们尝试更新一个具有给定 ID 的任务。发送一个 PUT 请求到 http://localhost:3000/api/tasks/1，并在请求正文中包含以下 JSON 数据：
{
"title": "Updated task",
"done": true
}应该返回以下 JSON 响应：
{
"id": 1,
"title": "Updated task",
"done": true
}最后，让我们尝试删除一个具有给定 ID 的任务。发送一个 DELETE 请求到 http://localhost:3000/api/tasks/1，并应该返回以下 JSON 响应：
{
"id": 1,
"title": "Updated task",
"done": true
}如果您尝试获取所有任务，应该只返回两个任务，因为我们已经删除了具有 ID 为 1 的任务。
结论
在本文中，我们学习了如何使用 Node.js 和 Express 框架来实现一个简单的 RESTful API 接口。我们设计了 API 接口，并编写了代码来实现每个接口。我们还学习了如何使用 Postman 或类似的工具来测试 API 接口。此外，我们还讨论了如何使用持久性存储来存储数据。希望本文对您有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/675fa566fc30a73a2ae58f15