Swagger 是一种用于描述和展示 RESTful API 的标准格式，提供了可视化的 API 文档，并允许用户进行交互测试和直接访问 API。在 Hapi 框架中添加 Swagger 文档可以方便地为其提供 API 文档和测试工具。
安装 Swagger
首先，在 Hapi 应用中安装 Swagger：
npm install hapi-swagger
配置 Swagger
使用 Swagger 需要进行一些配置。下面是一个简单的配置示例：
-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- ------ - ------------------
----- ----------- - ------------------------
----- ------ - --- --------------
------------------- ----- ---- ---
-----------------
------
-------
-
--------- ------------
-------- -
----- -
------ ---- ---------------
-------- ------
--
--
--
-- ----- -- -
-- ----- -
----- ----
-
----------------------- -- -
------------------- ------- -- ---------------------
---
---这个配置示例使用了 Inert 和 Vision 插件来为静态文件和模板提供支持，并且注册了 HapiSwagger 插件。其中，options 对象用来配置 Swagger 的信息，例如文档的标题和版本。
使用 Swagger
添加 Swagger 文档后，可以在浏览器中访问 Swagger UI 来查看和测试 API。Swagger UI 的地址是 http://localhost:3000/documentation，其中 localhost 和 3000 分别是你的服务器地址和端口号。
在 Swagger UI 中，你可以看到你的应用中存在的所有路由。点击某个路由，可以查看其参数和响应数据格式等信息，并且还可以直接在 UI 中测试接口。
总结
将 Swagger 添加到 Hapi 应用中，可以方便地为应用提供 API 文档和测试工具。在配置 Swagger 时，你可以设置一些选项，例如文档的标题和版本。使用 Swagger 时，可以通过 Swagger UI 直观地查看和测试接口。希望这篇文章对你使用 Hapi 和 Swagger 有所帮助！
示例代码
-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- ------ - ------------------
----- ----------- - ------------------------
----- ------ - --- --------------
------------------- ----- ---- ---
-----------------
------
-------
-
--------- ------------
-------- -
----- -
------ ---- ---------------
-------- ------
--
--
--
-- ----- -- -
-- ----- -
----- ----
-
--------------
------- ------
----- ----------------
-------- --------- ------ -- -
----- - ---- - - ---------------
------------- -----------
--
------- -
------------ ---- ----- -- ---------
----- --------
--------- -
------- -
----- ----------------------------------------------- ---- -- --- ----- -----
--
--
--
---
----------------------- -- -
-- ----- -
----- ---------
-
------------------- ------- -- ---------------------
---
---来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6495d6d448841e98942dec56