在前端开发中，API 文档是非常重要的一部分。它们不仅可以帮助团队内部更好地协作，还可以让第三方开发人员更好地了解你的项目。在 Hapi.js 项目中使用 Swagger 来生成 API 文档，可以大大简化这个过程。
什么是 Swagger？
Swagger 是一种 RESTful API 的文档生成工具，可以通过一个 JSON 或 YAML 文件来自动生成 API 文档。它支持多种编程语言和框架，包括 Hapi.js。Swagger 的主要目的是提高 RESTful API 的开发效率，以及提高 API 文档的可读性和可维护性。
Hapi.js 中使用 Swagger
在 Hapi.js 项目中使用 Swagger，需要安装两个 npm 包：hapi-swagger 和 inert。其中，hapi-swagger 是 Swagger 的 Hapi 插件，用于集成 Swagger 到 Hapi.js 项目中；inert 是 Hapi.js 的静态文件插件，用于在 Hapi.js 项目中提供静态文件服务。
安装 hapi-swagger 和 inert
npm install hapi-swagger inert --save
集成 Swagger 到 Hapi.js 项目中
在 Hapi.js 项目的 server.js 文件中，添加以下代码：
-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- ----------- - ------------------------
----- ---- - ---------------------
----- ------ - --- -------------
----- ------------
----- -----
---
----- -------------- - -
----- -
------ ---- ----
-------- -------------
--
--
----- ---- - ----- -- -- -
----- -----------------
------
-
------- ------------
-------- ---------------
--
---
--------------
------- ------
----- ----
-------- -------- --------- -- -
------ ------- --------
--
---
----- ---------------
------------------- ------- --- ---------------------
--
-------------------------------- ----- -- -
-----------------
----------------
---
-------在这个例子中，我们创建了一个 Hapi.js 服务器，并使用 hapi-swagger 和 inert 插件将 Swagger 集成到项目中。我们还创建了一个简单的路由，用于测试服务器是否正常运行。
添加 Swagger 文档
在 Hapi.js 项目的 routes 目录中，创建一个名为 index.js 的文件，并添加以下代码：
-- -------------------- ---- -------
-------------- - -
-
------- ------
----- ---------
-------- -
-------- -------- --------- -- -
------ ------- --------
--
------------ -------
------ ----------
----- --------
--
--
--在这个例子中，我们创建了一个名为 /hello 的路由，用于测试服务器是否正常运行。我们还使用 options 对象添加了一些 Swagger 文档信息，包括接口的描述、返回值的说明和标签。
查看 Swagger 文档
在浏览器中访问 http://localhost:3000/documentation，就可以查看生成的 Swagger 文档了。你可以在这里看到所有的接口信息，包括请求和响应的参数、请求和响应的示例、请求和响应的头部信息等等。
结论
在 Hapi.js 项目中使用 Swagger 来生成 API 文档，可以大大简化文档编写的过程。Swagger 可以自动生成文档，包括请求和响应的参数、请求和响应的示例、请求和响应的头部信息等等。这样，你就可以更专注于开发，而不用花费太多时间在文档编写上。
示例代码
完整的示例代码可以在我的 GitHub 上找到：https://github.com/wendyhu/hapi-swagger-example。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67427e32db344dd98dda6d0e