RESTful API（即：“表现层状态转化”）是一种常用的 Web API。RESTful 是一种适合于现代 Web 应用程序的轻量级架构设计风格，它使用 HTTP 协议进行通信，并且提供易于使用和维护的 Web 应用程序接口。
在本文中，我们将介绍如何使用 Express.js 框架搭建 RESTful API 实例。首先我们将探讨 RESTful API 的概念和设计原则，然后介绍如何使用 Express.js 框架来实现它。
RESTful API 的设计原则
RESTful API 遵循一组简单的设计原则。这些原则表现在URL的结构、HTTP 动词、请求数据和响应数据等方面：
使用清晰的 URL 结构： URL 的结构应该清晰明了，可以很容易地了解资源的类型和操作。例如，
/api/users表示用户资源，/api/users/:id表示指定用户的资源。使用标准的 HTTP 动词： RESTful API 使用标准的 HTTP 动词，如 GET、POST、PUT 和 DELETE来表示对资源的操作。
处理请求和响应的数据格式应该是 JSON 或 XML。
实现状态的转移和无状态的 API： RESTful API 是一种无状态的设计风格，在请求时传递必要的状态信息。此外，RESTful API 应该能够处理状态的转移，比如从一个资源到另一个资源的转移。
使用 Express.js 实现 RESTful API
Express.js 是一个流行的 Node.js Web 框架，它为开发 RESTful API 提供了很多方便的工具。下面我们将介绍如何使用 Express.js 框架创建 RESTful API。
安装和配置 Express.js
首先，我们需要安装 Express.js 框架。可以使用 npm 包管理器进行安装：
npm install express
在安装 Express.js 后，我们需要创建一个新的工作空间并初始化一个新的 Node.js 项目：
mkdir my-express-api cd my-express-api npm init
在初始化项目时，需要指定 Node.js 的入口文件为 app.js：
-- -------------------- ---- -------
-
------- -----------------
---------- --------
-------------- --- ---------- ------- -----
------- ---------
--------------- -
---------- ---------
-
-定义路由
在 Express.js 中，路由是定义 URL 和 HTTP 动词之间映射的机制。我们需要定义路由来处理 RESTful API 的请求。
下面是一个基本的路由定义：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ------------ ----- ---- -- - --------------- --------- --- ---------------- -- -- - ------------------- --------- -- ---- ------- ---
在此示例中，我们使用 app.get 方法定义了 / 路由。当应用程序接收到 GET 请求时，就会调用应用程序中定义的路由回调函数，并返回 Hello World! 作为响应。
处理请求和响应
Express.js 可以方便地进行请求和响应的处理。在 Express.js 中，我们可以通过请求对象和响应对象来访问请求和响应的数据。
下面是一个示例，用于处理 POST 请求：
app.post('/api/users', (req, res) => {
const user = req.body;
console.log(user);
res.send(`User ${user.name} has been created`);
});在此示例中，我们定义了一个 /api/users 路由，并在路由回调函数中从请求对象中获取用户数据，处理完数据后返回响应。
实现 CRUD 操作
RESTful API 根据资源的类型提供基本的 CRUD 操作：create（创建）、read（读取）、update（更新）和 delete（删除）。在 Express.js 中，可以使用以下方式实现这些操作：
- 创建资源：使用 POST 请求向 API 中添加新的资源。
- 读取资源：使用 GET 请求从 API 中获取资源。
- 更新资源：使用 PUT 请求更新已存在的资源。
- 删除资源：使用 DELETE 请求删除某个资源。
下面是一个示例，用于实现 CRUD 操作：
-- -------------------- ---- -------
-- --- -----
--------------------- ----- ---- -- -
----------------
---
-- --- - ---- -- --
------------------------- ----- ---- -- -
----- - -- - - -----------
----- ---- - --------------- -- ------- --- --------------
-- ------ -
---------------
- ---- -
-------------------------- --- --------
-
---
-- ------ - ----
---------------------- ----- ---- -- -
----- ---- - ---------
-----------------
-------------- ------------ --- ---- ----------
---
-- ------ - ----
------------------------- ----- ---- -- -
----- - -- - - -----------
----- ----------- - ---------
----- ----- - -------------------- -- ------- --- --------------
-- ------ --- --- -
------------ - ------------
-------------- ------------------- --- ---- ----------
- ---- -
-------------------------- --- --------
-
---
-- ------ - ----
---------------------------- ----- ---- -- -
----- - -- - - -----------
----- ----- - -------------------- -- ------- --- --------------
-- ------ --- --- -
------------------- ---
-------------- ----- --- ---- ----------
- ---- -
-------------------------- --- --------
-
---在此示例中，我们定义了针对用户的四个路由：/api/users、/api/users/:id、POST /api/users 和 DELETE /api/users/:id。这些路由用于获取用户、向 API 中添加新用户、更新用户和删除用户。
总结
在本文中，我们探讨了 RESTful API 的基本概念和设计原则，并介绍了如何使用 Express.js 框架创建 RESTful API。我们看到了如何定义路由、处理请求和响应，并实现基本的 CRUD 操作。通过学习本文，我们可以轻松地创建和实现 RESTful API，并用于构建我们的 Web 应用程序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64c2383883d39b48816432d7