概述
API 文档是前后端协作中非常重要的一环，通过编写接口文档可以使前端与后端开发人员更加协同有效地开发。在开发完成后，我们需要进行测试以保证 API 接口的可用性。本文主要介绍如何在 Hapi 框架中使用 Swagger 进行 API 文档的在线测试。
Swagger 是什么
Swagger 是一个工具集，可以生成、发布、维护和可视化 RESTful Web 服务的文档。通过使用 Swagger，我们可以自动生成客户端 SDK 和服务的 API 文档，使 API 接口更加清晰、易于使用和扩展。
Hapi 框架
Hapi 是 Node.js 的一个 Web 框架，通过使用 Hapi，我们可以更加容易地编写 Web 应用程序和服务。Hapi 的主要特点是可插拔架构、可重用组件和可扩展性。
Hapi 中如何使用 Swagger
在 Hapi 中使用 Swagger 可以通过两种方式实现：使用 Hapi 官方提供的插件 swagger 插件或者使用第三方插件 hapi-swagger。
安装 Swagger 插件
首先，我们需要在 Hapi 项目中安装官方的 swagger 插件。
npm install hapi-swagger --save
然后，我们需要在项目中引用插件并将其注册到 Hapi 服务中：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ------------- - ------------------------
----- ------- - --------------------------
----- ------ - --- -------------
----- -----
----- -----------
---
----- -------------- - -
----- -
------ ---- ---------------
-------- ----------------
--
------------------ --------
--------- -----------------
--------- ---
--
----- -----------------
-
------- --------------
-------- --------------
-
---
----- ---------------
------------------- ------- -- ---------------------在上述代码中，我们首先导入 Hapi、swagger 插件和我们的项目的 package.json 文件。然后，我们定义了 swagger 插件的配置选项并将其注册到 Hapi 服务中。
在配置选项中，我们定义了 API 文档的基本信息，包括文档标题、版本号和文档存储的位置。我们在 Hapi 服务中注册了 swagger 插件之后，访问 /docs 路径即可查看我们的 API 文档。
安装 hapi-swagger 插件
hapi-swagger 是一个第三方插件，它可以更加方便地将 Swagger 集成到我们的 Hapi 项目中。
我们可以通过 npm 执行以下命令来安装 hapi-swagger 插件：
npm install hapi-swagger --save
安装完成后，我们需要在 Hapi 服务中引用插件并进行配置：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ----------- - ------------------------
----- ----- - -----------------------
----- ------ - ------------------------
----- ------- - --------------------------
----- ------ - --- -------------
----- -----
----- -----------
---
----- -------------- - -
----- -
------ ---- ---------------
-------- ----------------
--
------------------ --------
--------- ---
--
----- -----------------
------
-------
-
------- ------------
-------- --------------
-
---
----- ---------------
------------------- ------- -- ---------------------在上述代码中，我们首先导入 Hapi、hapi-swagger 插件、Inert 和 Vision 插件，然后我们定义了 swagger 插件的配置选项并将其注册到 Hapi 服务中。在注册 swagger 插件之前，我们需要先注册 Inert 和 Vision 插件，因为 hapi-swagger 插件依赖于这两个插件。
与前面的例子类似，我们在 swaggerOptions 中定义了文档的基本信息，并将其注入到 hapi-swagger 插件中。
当我们在浏览器中访问 /docs 路径时，会自动打开 Swagger UI，并展示我们创建的 API 文档。
总结
本文介绍了如何在 Hapi 框架中使用 Swagger 进行 API 文档的在线测试。通过安装 Hapi 插件或者第三方插件 hapi-swagger，我们可以更加方便地集成 Swagger 到我们的项目中，从而更加清晰地定义、测试和维护我们的 API 接口。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/652239c895b1f8cacd9a239e