Fastify 是一个高效、低开销、异步且具有低水平开销的 Web 框架，是目前比较流行的 Node.js HTTP 服务器。在本文中，我们将学习如何使用 Fastify 2.X 创建 RESTful 服务的 API 设计。
RESTful API 设计的基本原则
在设计 RESTful 接口时，请遵循以下基本原则：
- 使用 HTTP 动词来表示操作类型，例如 GET、POST、PUT、DELETE 等。
- 遵循资源命名原则，即 URI 应该命名为资源，并使用斜杠（/）分隔符。
- 通过HTTP 状态码提供响应。
Fastify 的基本使用
在使用 Fastify 开始开发 RESTful API 前，我们需要安装 Fastify，可以通过以下命令安装：
npm install fastify
然后我们可以根据下面的示例代码来创建一个 Fastify 应用：
-- -------------------- ---- -------
----- ------- - --------------------
---------------- -------- --------- ------ -
------------ ------ ------- --
--
-------------------- -------- ----- -------- -
-- ----- -
------------------
---------------
-
------------------- ------- -- ------------
--在上面的代码中，我们创建了一个名为 fastify 的应用程序对象，通过 fastify.get() 方法将 response 对象中的数据作为 JSON 格式返回。
创建 RESTful API
在 Fastify 中，我们可以使用路由（router）来定义 HTTP 动词（HTTP verbs），以及处理与请求相关的中间件逻辑。下面是一个基本的 RESTful API：
-- -------------------- ---- -------
----- ------- - --------------------
----- -------- - -
- --- -- ----- ------ ---- -- --
- --- -- ----- -------- ---- -- -
-
------------------------ -------- --------- ------ -
--------------------
--
---------------------------- -------- --------- ------ -
----- --------- - -------------------------
----- ------- - --------------- -- ---- --- ----------
-- --------- -
-------------------
- ---- -
---------------------- ------ -------- --- ------ --
-
--
------------------------- -------- --------- ------ -
---------------------------
----------------------------------
--
-------------------- -------- ----- -------- -
-- ----- -
------------------
---------------
-
------------------- ------- -- ------------
--在上面的代码中，我们定义了三个路由处理程序：
GET /students：返回所有学生的列表。GET /students/:id：通过 ID 返回学生对象。POST /students：将新学生添加到列表中。
在 fastify.post() 函数中，我们获取 request.body 或 request.payload 对象，以将 POST 请求的数据作为新的学生添加到 students 数组中。
响应 HTTP 状态码的作用
RESTful API 中的 HTTP 状态码是标准的响应代码，用于指示服务器已成功完成（或未能完成）请求的操作。它们通常在 API 的响应体中随着数据一起传递。
以下是一些常见的 HTTP 状态码：
200 OK：请求成功，并返回数据。201 Created：请求成功，并且在服务器上创建了一个新的资源。204 No Content：请求成功，但没有任何内容返回。400 Bad Request：请求无效或格式不正确。401 Unauthorized：没有提供认证凭证，或认证凭证无效。403 Forbidden：请求被拒绝，没有权限访问资源。404 Not Found：请求的资源不存在。500 Internal Server Error：服务器内部错误，无法完成请求。
在上面的示例中，我们使用 code 函数设置了一个新的状态码。 例如在 reply.code(404) 中，我们设置了状态码 404，这表明请求的资源不存在。
结论
本文简要介绍了如何使用 Fastify 开发 RESTful API。通过在 Fastify 中创建路由，我们可以使用路由处理程序来定义 HTTP 动词和中间件逻辑。还介绍了 HTTP 状态码在 RESTful API 中的作用。我们希望你在使用 Fastify 开发 RESTful API 时能够更加得心应手。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67502598fbd23cf89073c399