Swagger 是一种流行的 API 规范和文档工具，提供了许多功能，例如参数验证。在 Hapi 框架中，可以使用 Swagger 作为参数验证器来确保客户端请求的有效性。本文将介绍如何在 Hapi 中使用 Swagger 进行参数验证，并附带示例代码。
什么是 Swagger？
Swagger 是一个开源框架，用于设计、构建、文档化和测试 RESTful API。它定义了 API 的结构和约束，并支持各种编程语言。Swagger 在 API 开发生命周期的不同阶段提供了很多辅助工具和功能，例如：
- 自动化 API 文档生成
- 在线测试 API 请求
- 客户端 SDK 自动生成
- 接口测试用例生成
在 Hapi 框架中使用 Swagger
Hapi 是一个使用 Node.js 构建 Web 应用程序的框架。在 Hapi 中，可以使用 Swagger 进行 API 参数验证。接下来，我们将介绍如何在 Hapi 中使用 Swagger 进行参数验证的详细步骤：
- 安装必要的依赖项
npm install @hapi/hapi joi @hapi/inert @hapi/vision hapi-swagger
- 创建 server
首先，创建一个 Hapi 服务器并添加所需插件（需要 inert 和 vision 插件来加载 Swagger 文档）。
-- -------------------- ---- -------
----- ---- - ---------------------
----- ----- - ----------------------
----- ------ - -----------------------
----- ----------- - -----------------------
----- ---- - --------------------
----- ------ - -------------
----- -----
----- -----------
--
----- ---- - ----- -- -- -
----- -----------------
------
-------
-
------- ------------
-------- -
----- -
------ --- --- ---------------
-------- ------------
-
-
-
--
-可以看到，在注册插件时，我们将 HapiSwagger 插件添加到了插件数组中，并提供了一些相关的配置信息，例如文档标题和版本号。
- 添加路由
在 Hapi 中，路由由一个对象表示，拥有以下属性：
method：HTTP 请求方法，例如 GET、POST 等。path：路径模板。handler：用于处理请求并返回响应的函数。
-- -------------------- ---- -------
--------------
------- ------
----- --------------
-------- --------- -- -- -
------ - --- ----------------- -
--
-------- -
--------- -
------- ------------
--- -----------------------------
--
--
------------ ---- - ---- -- ----
----- -------
-
--可以看到，在路由定义中，我们使用了 validate 属性来指定参数验证规则。这里使用 Joi 类库来定义参数验证规则。在这个例子中，我们验证了 id 参数必须是一个正整数且最小值为 1。
同时，我们还使用了 description 和 tags 属性来描述该路由的功能和标记它属于哪个分类。这些信息可以通过 Swagger 文档呈现出来。
- 运行服务器
-- -------------------- ---- ------- ----- ----- - ----- -- -- - ----- -------------- ------------------- ------- -- -------------------- - -------------------------------- ----- -- - ---------------- --------------- -- ------ ------------
我们可以运行该服务器并打开链接 http://localhost:3000/documentation 来查看 Swagger 文档界面。Swagger 会自动解析路由定义并生成文档。
结论
本文介绍了如何在 Hapi 框架中使用 Swagger 进行 API 参数验证
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67556e753af3f99efe4cad3f