作为一名前端开发者，当我们开发完 API 接口后，如何直观清晰地展示出这些接口的信息、参数、调用方法等内容，对于开发者和其他团队成员来说都是非常重要的。本文将介绍如何使用 Hapi 框架生成自己的 API 文档，并实现在线查看和测试接口的功能。
了解 Hapi 框架
Hapi 是一个用于构建 Web 应用程序和服务的框架，由 Walmart 开发并维护。其优点之一是提供了完整的插件系统，可以很方便地扩展和定制功能。同时 Hapi 也内置了许多流行的插件和工具，如路由、缓存、日志、验证、测试等。
安装和配置 Hapi
首先需要全局安装 Hapi：
npm install -g hapi
创建一个新的 package.json 文件，并安装项目依赖：
npm init -y npm install hapi joi inert
其中 joi 用于校验请求参数，inert 用于在 Hapi 中使用静态文件。
创建一个新的 JavaScript 文件来编写 API 接口：
-- -------------------- ---- -------
----- ---- - ----------------
----- --- - ---------------
-- -----
----- ------ - -------------
----- -----
----- -----------
---
-- ----
--------------------------------- ----- -- -
-- ----- -
----- ----
-
--------------
------- ------
----- ----
-------- -
----- --------------
-
---
---
-- --- --
--------------
------- ------
----- -------------
-------- --------- -- -- -
------ ------ -------
--
-------- -
----- --------
------------ ---- ----- -------
--------- -
-------- ------------
---------------- -----------------------
------------ ------------- ---- --
-
-
---
-- -----
----- -------- ------- -
--- -
----- ---------------
------------------- ------- --- ---------------------
- ----- ----- -
-----------------
----------------
-
-
--------以上代码中：
server.register方法用于注册插件，这里注册了inert插件来使用静态文件；server.route方法用于定义路由，这里定义了一个 GET 请求/api/hello接口，其中options里的内容就是为了后面生成 API 文档服务的。
最后在控制台中运行：
node app.js
就可以在浏览器中访问 http://localhost:3000 来查看网页和 http://localhost:3000/api/hello 来测试 API 接口。
生成 API 文档
在 Hapi 中，可以使用 hapi-swagger 插件来生成 API 文档。它可以根据你的路由信息自动构建 API 文档，包括接口名称、参数、请求方法、响应状态等信息，并可在线测试接口。
安装并注册 hapi-swagger：
npm install hapi-swagger
-- -------------------- ---- -------
----- ---- - ----------------
----- --- - ---------------
----- ----- - -----------------
----- ------ - ------------------
----- ----------- - ------------------------
----- ---- - ---------------------
-- -----
----- ------ - -------------
----- -----
----- -----------
---
-- ----
----- ------- - -
------
-------
-
------- ------------
-------- -
----- -
------ ---- ---------------
-------- ------------
-
-
-
--
-- ----
----- ---- - ----- -- -- -
----- -------------------------
-- ------
--------------
------- ------
----- ----
-------- -
----- --------------
-
---
-- --- ----
--------------
------- ------
----- -------------
-------- --------- -- -- -
------ ------ -------
--
-------- -
----- --------
------------ ---- ----- -------
--------- -
-------- ------------
---------------- -----------------------
------------ ------------- ---- --
-
-
---
--
-------
-- -----
----- ----- - ----- -- -- -
--- -
----- ---------------
------------------- ------- --- ---------------------
- ----- ----- -
-----------------
----------------
-
--
--------在以上代码中，我们引入了 Inert 插件来加载静态文件，Vision 插件来注册 HapiSwagger，并设置了一些基础文档信息。
当访问 http://localhost:3000/documentation 时，将出现自动生成的 API 文档页面，浏览器中可以查看所有的接口信息、参数、请求地址等，并且可以在线测试 API 接口，方便调试。
结论
使用 Hapi 框架可以很方便地生成 API 文档，并且还能够在线测试，大大提高了接口的开发效率和测试效果。同时，学习 Hapi 框架的使用方法也能够帮助我们更好地理解 Node.js 的事件机制和异步编程思想，为我们进行后续的 Node.js 开发提供更多参考和思路。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/674e9426e884a3e30f284695