Fastify 是一个快速、低开销、可扩展的 Node.js Web 框架，它提供了一系列强大的工具和插件，使得开发者可以轻松地构建高效的 Web 应用程序。而 OpenAPI 则是一种用于 RESTful API 的标准化描述语言，它可以帮助开发者更好地定义 API，提高 API 的可读性和可维护性。
在本文中，我们将介绍如何在 Fastify 框架中使用 OpenAPI 来定义 API，以及如何使用 Swagger UI 来可视化 API 文档。我们将会详细讲解每一步的操作，并提供示例代码，帮助读者更好地理解和应用这些技术。
安装依赖
首先，我们需要安装一些必要的依赖。在终端中运行以下命令：
npm install fastify fastify-oas swagger-ui-fastify
其中，fastify 是 Fastify 框架本身，fastify-oas 是 Fastify 的 OpenAPI 插件，swagger-ui-fastify 是用于可视化 API 文档的 Swagger UI 插件。
定义 API
接下来，我们需要定义我们的 API。我们可以使用 Fastify 提供的路由来定义 API，如下所示：
-- -------------------- ---- -------
----- ------- - --------------------
--------------------------- --------- ------ -- -
----- - ---- - - --------------
------------ -------- ------- --------- --
--
-------------------- ----- -- -
-- ----- -
------------------
---------------
-
------------------- --------- -- ---- ------
--上面的代码定义了一个 /hello/:name 的 API，当我们向该 API 发送 GET 请求时，它会返回一个 JSON 对象，其中包含一个 message 属性，值为 Hello, ${name}!，其中 ${name} 为请求参数中的 name。
使用 OpenAPI 描述 API
现在，我们可以使用 OpenAPI 描述我们的 API。我们可以在 fastify 实例上调用 register 方法，将 fastify-oas 插件注册到应用程序中，如下所示：
-- -------------------- ---- -------
----- ------- - --------------------
----- ---------- - ----------------------
---------------------------- -
------------ --------
------------ -----
-------- -
----- -
------ --- -----
------------ ---- ---------------
-------- -------
--
-------- -- ---- ----------------------- ---
----- -- ----- -------- ------------ ------ ---- ---
------ --
-
--
--------------------------- -
------- -
------- -
----- ---------
----------- -
----- -
----- ---------
------------ ---- ---- -- --- ------ -- ------
-
-
-
-
-- --------- ------ -- -
----- - ---- - - --------------
------------ -------- ------- --------- --
--
-------------------- ----- -- -
-- ----- -
------------------
---------------
-
------------------- --------- -- ---- ------
--在上面的代码中，我们首先将 fastify-oas 插件注册到应用程序中，并在 Swagger UI 中公开 API 文档。然后，我们定义了一个 /hello/:name 的 API，并在 API 的 schema 中定义了请求参数的类型和属性。最后，我们启动了 Fastify 服务器，让它在 http://localhost:3000 上监听请求。
可视化 API 文档
现在，我们已经定义了 API 并使用 OpenAPI 描述了它们。接下来，我们可以使用 Swagger UI 可视化我们的 API 文档。我们可以在 fastify 实例上调用 register 方法，将 swagger-ui-fastify 插件注册到应用程序中，如下所示：
-- -------------------- ---- -------
----- ------- - --------------------
----- ---------- - ----------------------
----- --------- - -----------------------------
---------------------------- -
------------ --------
------------ -----
-------- -
----- -
------ --- -----
------------ ---- ---------------
-------- -------
--
-------- -- ---- ----------------------- ---
----- -- ----- -------- ------------ ------ ---- ---
------ --
-
--
--------------------------- -
------------ --------
-------- -
---- ------------
-
--
--------------------------- -
------- -
------- -
----- ---------
----------- -
----- -
----- ---------
------------ ---- ---- -- --- ------ -- ------
-
-
-
-
-- --------- ------ -- -
----- - ---- - - --------------
------------ -------- ------- --------- --
--
-------------------- ----- -- -
-- ----- -
------------------
---------------
-
------------------- --------- -- ---- ------
--在上面的代码中，我们首先将 swagger-ui-fastify 插件注册到应用程序中，然后在 Swagger UI 中指定 API 文档的 URL。最后，我们定义了一个 /hello/:name 的 API，并在 API 的 schema 中定义了请求参数的类型和属性。最后，我们启动了 Fastify 服务器，让它在 http://localhost:3000 上监听请求。
现在，我们可以在浏览器中访问 http://localhost:3000/docs，就可以看到我们的 API 文档了。我们可以在文档中查看 API 的详细信息，包括请求参数、响应体等等。这样，我们就可以更好地理解和使用我们的 API 了。
总结
在本文中，我们介绍了如何在 Fastify 框架中使用 OpenAPI 来定义 API，并使用 Swagger UI 可视化我们的 API 文档。我们详细讲解了每一个步骤的操作，并提供了示例代码，帮助读者更好地理解和应用这些技术。希望本文对读者有所帮助，谢谢阅读！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65d19de8add4f0e0ffa4233a