Swagger 是一个流行的 API 文档生成工具，它可以帮助开发者自动生成 API 文档，方便其他开发者使用和理解接口。在 Hapi.js 中集成 Swagger 文档可以提高接口的可读性和可维护性。本文将介绍如何在 Hapi.js 中集成 Swagger 文档。
安装 Swagger
首先，我们需要安装 Swagger。可以通过以下命令安装：
npm install swagger --save
集成 Swagger
在 Hapi.js 中集成 Swagger，我们需要使用 hapi-swagger 插件。可以通过以下命令安装：
npm install hapi-swagger --save
在 Hapi.js 项目中添加以下代码：
-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- ------ - ------------------
----- ----------- - ------------------------
----- ---- - ---------------------
----- ------ - --- --------------
-------------------
----- ------------
----- ----
---
----- -------------- - -
----- -
------ ----- --- ---------------
-------- -------------
--
--
-----------------
------
-------
-
--------- ------------
-------- --------------
-
-- ----- -- -
-- ----- -
----- ----
-
------------------ -- -
-- ----- -
----- ----
-
------------------- ------- --- ---------------------
---
---以上代码中，我们使用 server.connection 方法创建一个服务器实例，并在 register 方法中注册了 Inert、Vision 和 HapiSwagger 插件。其中，HapiSwagger 插件的配置项包含了 API 文档的标题和版本号。
编写 API 文档
在 Hapi.js 中使用 Swagger，我们需要为每个路由编写 API 文档。可以使用 route.options 方法来定义文档，例如：
-- -------------------- ---- -------
--------------
------- ------
----- ----------------
-------- -------- --------- ------ -
------------- - - ------------------- - -----
--
------- -
----- --------
------------ ---- ----- -- ---------
--------- -
------- -
----- -----------------------
-
-
-
---在以上代码中，我们使用 config 属性来定义 API 文档。其中，tags 属性用于分类 API，description 属性用于描述 API 的功能，validate 属性用于验证输入参数。
查看 API 文档
在 Hapi.js 项目启动后，我们可以通过访问 http://localhost:3000/documentation 来查看生成的 API 文档。该页面会列出所有的 API，包括其分类、描述和输入参数验证规则。
总结
本文介绍了如何在 Hapi.js 中集成 Swagger 文档。通过使用 hapi-swagger 插件，我们可以方便地为每个路由编写 API 文档，并且可以通过访问 http://localhost:3000/documentation 来查看生成的文档。希望本文能够帮助读者了解如何在 Hapi.js 中使用 Swagger。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66408554d3423812e4ea5346