Fastify 是一个快速、低开销、可扩展的 Web 框架，可以帮助开发人员快速构建高效的 RESTful API。Swagger 是一个流行的 API 规范和工具集，可帮助开发人员设计、构建和文档化 RESTful API。在本文中，我们将介绍如何使用 Fastify 和 Swagger 构建 RESTful API。
安装和配置 Fastify
首先，我们需要安装 Fastify。可以使用 npm 进行安装：
npm install fastify --save
安装完成后，我们可以创建一个简单的 Fastify 应用程序：
-- -------------------- ---- ------- ----- ------- - -------------------- ---------------- ----- --------- ------ -- - ------ - ------ ------- - -- -------------------- ----- -------- -- - -- ----- ----- --- ------------------- --------- -- ------------ --
该应用程序定义了一个基本的路由，当访问根路径时返回一个 JSON 对象。
安装和配置 Swagger
接下来，我们需要安装 Swagger。可以使用 npm 进行安装：
npm install swagger-ui-fastify swagger-fastify --save
安装完成后，我们需要将 Swagger 集成到 Fastify 应用程序中：
-- -------------------- ---- ------- ----- ------- - -------------------- ----- ------- - ----------------------------- ----- ------------- - ------------------------- -------------------------------------------- - ------------ ----- -------- ------------- -- ------------------------- - -------- -------------- ------- ------- -- ---------------- ----- --------- ------ -- - ------ - ------ ------- - -- -------------------- ----- -------- -- - -- ----- ----- --- ------------------- --------- -- ------------ --
在上面的代码中，我们首先将 Swagger 配置文件加载到应用程序中，然后使用 swagger-fastify 插件将 Swagger 集成到 Fastify 应用程序中。我们还使用 swagger-ui-fastify 插件将 Swagger UI 添加到 /docs 路径上。
创建 RESTful API
现在我们已经安装和配置了 Fastify 和 Swagger，我们可以开始创建 RESTful API。我们将创建一个简单的待办事项应用程序，其中包含以下 API 路由：
- 获取所有待办事项
- 创建新的待办事项
- 获取单个待办事项
- 更新现有待办事项
- 删除现有待办事项
我们将使用 Fastify 的路由功能来定义这些路由。首先，我们将定义 GET /todos 路由，用于获取所有待办事项：
fastify.get('/todos', async (request, reply) => {
const todos = await Todo.find()
return { todos }
})在上面的代码中，我们使用 Todo.find() 方法从数据库中获取所有待办事项，并将其作为 JSON 对象返回。
接下来，我们将定义 POST /todos 路由，用于创建新的待办事项：
fastify.post('/todos', async (request, reply) => {
const todo = new Todo(request.body)
await todo.save()
return { todo }
})在上面的代码中，我们使用 new Todo() 方法创建一个新的待办事项，并使用 todo.save() 方法将其保存到数据库中。
接下来，我们将定义 GET /todos/:id 路由，用于获取单个待办事项：
fastify.get('/todos/:id', async (request, reply) => {
const todo = await Todo.findById(request.params.id)
return { todo }
})在上面的代码中，我们使用 Todo.findById() 方法从数据库中获取指定 ID 的待办事项，并将其作为 JSON 对象返回。
接下来，我们将定义 PUT /todos/:id 路由，用于更新现有待办事项：
fastify.put('/todos/:id', async (request, reply) => {
const todo = await Todo.findByIdAndUpdate(request.params.id, request.body, { new: true })
return { todo }
})在上面的代码中，我们使用 Todo.findByIdAndUpdate() 方法更新指定 ID 的待办事项，并将其作为 JSON 对象返回。
最后，我们将定义 DELETE /todos/:id 路由，用于删除现有待办事项：
fastify.delete('/todos/:id', async (request, reply) => {
const todo = await Todo.findByIdAndDelete(request.params.id)
return { todo }
})在上面的代码中，我们使用 Todo.findByIdAndDelete() 方法从数据库中删除指定 ID 的待办事项，并将其作为 JSON 对象返回。
编写 Swagger 规范
现在我们已经定义了所有的 API 路由，我们需要编写 Swagger 规范来描述这些路由。我们将使用 YAML 格式编写 Swagger 规范。以下是我们的 Swagger 规范：
-- -------------------- ---- -------
-------- -----
-----
------ ---- ---
-------- -----
--------
- ---- -----------------------
------
-------
----
-------- --- --- -----
----------
----
------------ --
--------
-----------------
-------
----- ------
-----------
------
----- -----
------
----- ---------------------------
-----
-------- ------ - --- ----
------------
--------- ----
--------
-----------------
-------
----- ---------------------------
----------
----
------------ --
--------
-----------------
-------
----- ------
-----------
-----
----- ---------------------------
------------
-----------
- ----- --
--- ----
--------- ----
------------ -- -- --- ----
-------
----- ------
----
-------- --- - ------ ----
----------
----
------------ --
--------
-----------------
-------
----- ------
-----------
-----
----- ---------------------------
----
-------- ------ - ----
------------
--------- ----
--------
-----------------
-------
----- ---------------------------
----------
----
------------ --
--------
-----------------
-------
----- ------
-----------
-----
----- ---------------------------
-------
-------- ------ - ----
----------
----
------------ --
--------
-----------------
-------
----- ------
-----------
-----
----- ---------------------------
-----------
--------
-----
----- ------
-----------
----
----- ------
------
----- ------
----------
----- -------在上面的代码中，我们定义了所有的 API 路由，并使用 $ref 引用了 Todo 模型。我们还定义了 Todo 模型的属性，包括 _id、title 和 completed。
运行应用程序
现在我们已经编写了所有的代码和 Swagger 规范，我们可以运行应用程序并查看 Swagger UI。运行以下命令以启动应用程序：
node app.js
然后，打开浏览器并访问 http://localhost:3000/docs，您将看到 Swagger UI。在 Swagger UI 中，您可以查看所有的 API 路由，并测试它们是否正常工作。
结论
在本文中，我们介绍了如何使用 Fastify 和 Swagger 构建 RESTful API。我们首先安装和配置了 Fastify 和 Swagger，然后创建了一个简单的待办事项应用程序，并定义了所有的 API 路由。最后，我们编写了 Swagger 规范，并使用 Swagger UI 测试了我们的 API 路由。Fastify 和 Swagger 是构建高效、可扩展和易于维护的 RESTful API 的强大工具，希望这篇文章能够帮助您开始构建自己的 API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/677a0d625c5a933a34103966
