简介
OpenAPI/Swagger 是一个强大的 API 文档化和测试工具，它可以极大地简化 API 的开发和文档编写过程。Fastify 是一个类似于 Express 的 Node.js Web 框架，它非常快速和灵活。在本文中，我们将介绍如何在 Fastify API 中使用 OpenAPI/Swagger。
步骤
第一步：安装 SwaggerUI
我们需要先安装 SwaggerUI，它是一个用于呈现和测试 API 文档的工具。
我们可以通过 NPM 进行安装：
npm install swagger-ui-dist
然后，我们需要添加一个路由来呈现 SwaggerUI：
-- -------------------- ---- -------
----- --------- - ---------------------------
----- -- - --------------
----- ---- - ----------------
----- ----------- - --------------------------
------------------------------------------- -
----- ------------------------------
------- --------------
---
---------------------------- ----- --------- ------ -- -
----- -------- - --------------------
----- -------- - ---------------------------------------- ----------
-- ------------------------- -
------ ------------------------ ----------
-
------ -------------- ----------- --- ---------
---
---------------- ----- --------- ------ -- -
-----------------------------------------------------------
---第二步：添加 Swagger 描述文件
我们需要创建一个 Swagger 描述文件来定义我们的 API。这个文件可以是 JSON 或 YAML 格式。在本教程中，我们将使用 JSON 格式。
-- -------------------- ---- -------
-
---------- --------
------- -
---------- --------
-------- --- -----
-------------- ---- ----------- -- -----------
----------------- ----------------------------
---------- -
-------- ---------------------
--
---------- -
------- ------- -----
------ --------------------------------------------------
-
--
---------- -
-
------ ------------------------
-------------- ------ -------
-
--
-------- -
--------- -
------ -
-------------- ----------------
------- -
-------
--
-------------- -------- ------- ---------
------------ -
------ -
-------------- -- ---------- ----------
---------- -
------------- -
--------- -
------- ---------
---------- ------- -------
-
-
-
--
---------- -
-------------- --- ----- ----------
---------- -
------------------- -
--------- -
------- ----------------------------
-
-
-
-
-
-
-
--
------------- -
---------- -
-------- -
------- ---------
------------- -
------- -
------- ----------
--------- -------
--
---------- -
------- --------
-
-
-
-
-
-第三步：将 Swagger 描述文件添加到 Fastify
我们需要在 Fastify 中注册插件来处理 Swagger 描述文件。
-- -------------------- ---- -------
----- ------------- - ---------------------------
----- -------------- - -
------------ -----------
-------- -
----- -
------ --- -----
------------ ---- ----------- -- -----------
-------- --------
--
--------- ---------------------
--------- ---------------------
--
------------ -----
----- ---------
---------- -----
------------------- -------- -- -------
------------------ -
----------- -----------
---------- -----------
-
-
------------------------------- ----------------第四步：编写 API 路由
这里我们为您提供了一个简单的 API 路由示例。我们将在该路由中使用 Swagger 描述文件中 /hello 路径的定义和注释。
-- -------------------- ---- -------
--------------------- -
------- -
--------- -
---- -
----- ---------
----------- -
-------- - ----- -------- -
-
-
-
-
-- ----- --------- ------ -- -
------------ -------- ------- ------- ---
---总结
我们已经学习了如何在 Fastify API 中使用 OpenAPI/Swagger。通过按照本文的步骤进行操作，我们可以轻松地创建具有优秀文档化和测试功能的 API，提高 API 的开发效率和可靠性。如果你想深入了解 Swagger 的其他功能，请访问官方文档了解更多。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64f6cb34f6b2d6eab3f54650