RESTful API 是现代 Web 应用的核心之一。为了构建灵活、高性能以及可扩展的 Web 应用，学习如何构建 RESTful API 是一个必要的技能。在本篇文章中，我们将深入探讨如何使用 Node.js 和 Express.js 构建一个完整的 RESTful API，以及它的学习和指导意义。
什么是 RESTful API？
REST（Representational State Transfer，表现层状态转移）指的是一种 Web 应用程序的架构风格，它通常使用 HTTP 协议进行通信。RESTful API 指的是按照 REST 风格设计的 Web API，其重点是资源的设计和管理。
在一个 RESTful API 中，资源可以被表示为 URL（Uniform Resource Locator），可以使用 HTTP 动词（GET，POST，PUT，DELETE，等等）对资源执行操作，以及使用 HTTP 状态码来传达操作结果。
使用 Node.js 和 Express.js 构建 RESTful API
Node.js 是一个开源的跨平台后端 JavaScript 运行时环境，它允许您使用 JavaScript 构建高性能的 Web 应用程序。Express.js 是一个流行的基于 Node.js 构建的 Web 应用程序框架，它可以轻松地构建 RESTful API。
在下面的示例中，我们将使用 Node.js 和 Express.js 构建一个简单的 RESTful API，以便更好地理解如何构建这样的 API。
首先，让我们创建新的 Node.js 项目并安装所需的依赖项。在命令行中输入以下命令：
mkdir my-restful-api && cd my-restful-api npm init -y npm install express body-parser cors
这将创建一个新的 Node.js 项目并安装所需的依赖项。
接下来，打开 app.js 文件并添加以下代码：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ---------- - ----------------------- ----- ---- - ---------------- ----- --- - ---------- ---------------- --------------------------- ------------ ----- ---- -- - ---------------- --------- --- ----- ---- - ---------------- -- ----- ---------------- -- -- - ------------------- --------- -- ---- ---------- ---
这将创建一个简单的 Express.js 应用程序，它使用 body-parser 中间件解析 JSON 请求体，使用 cors 中间件允许跨域请求，监听根路径请求并返回 "Hello, world!"。
现在，我们将创建一个 RESTful API。在 app.js 文件中添加以下代码：
-- -------------------- ---- -------
----- ----- - -
- --- -- ----- ------ --------- ---------- ---- --
- --- -- ----- ------ - ------- ----- ---------- ----- --
- --- -- ----- ------- -- - -------- ---------- ----- -
--
--- ------ - ------------ - --
----------------- ----- ---- -- -
----------------------------
---
------------------ ----- ---- -- -
----- ------- - -
--- ---------
----- --------------
---------- -----
--
--------------------
------------------------------
---
------------------------ ----- ---- -- -
----- -- - ------------------------
----- ----- - -------------------- -- ------- --- ----
-- ------ --- --- -
------------------- ---
--------------------
- ---- -
--------------------
-
---
--------------------- ----- ---- -- -
----- -- - ------------------------
----- ---- - --------------- -- ------- --- ----
-- ------ -
--------- - ------------- -- ----------
-------------- - ------------------ -- ---------------
---------------------------
- ---- -
--------------------
-
---在这个示例中，我们创建了一个名为 todos 的数组，其中包含三个具有 id、text 和 completed 属性的对象。我们创建了四个 API 路由以管理这些 todo：
- GET /todos：返回 todos 数组。
- POST /todos：创建一个新的 todo，并将其添加到 todos 数组中。
- DELETE /todos/:id：删除给定 id 的 todo。
- PUT /todos/:id：更新给定 id 的 todo。
现在，我们可以使用 cURL（或其他类似的工具）来测试我们构建的 RESTful API：
curl http://localhost:3000/todos
curl -X POST -d '{"text":"Learn React"}' -H 'Content-Type: application/json' http://localhost:3000/todos
curl -X PUT -d '{"text":"Learn Vue", "completed":true}' -H 'Content-Type: application/json' http://localhost:3000/todos/1
curl -X DELETE http://localhost:3000/todos/1这些命令将测试我们的 RESTful API 并返回相应的结果。
结论
在本文中，我们深入探讨了如何使用 Node.js 和 Express.js 构建 RESTful API。我们了解了 RESTful API 的定义、特点以及如何使用 Node.js 和 Express.js 构建一个简单的 RESTful API。这将为更深入的 Web 开发学习奠定坚实的基础，并在日常开发中提供灵活、高性能和可扩展的解决方案。
完整示例代码： https://github.com/example/my-restful-api
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/670c940a5f551281025b1b10