在现代 Web 应用程序开发中，使用 API 是非常常见的。为了简化 API 管理过程，最近一个新兴的趋势是使用 OpenAPI 规范来描述 API 定义。本文将介绍如何在 Hapi 框架中使用 OpenAPI 进行 API 管理。
什么是 OpenAPI？
OpenAPI 规范（也称为 Swagger 规范）是一种描述 RESTful API 的开放标准。它以可读性和易用性为设计原则，提供了一个文档格式以及一组语言无关的 API 定义操作。它还以 YAML 或 JSON 形式提供了 API 的说明和例子，可以供开发人员和消费者进行测试和开发使用。
使用 Hapi 框架和 OpenAPI 描述 API
Hapi 是一个现代化的、可扩展的 Node.js Web 应用程序框架。它的优点在于灵活性和可扩展性。Hapi 使 API 的创建变得非常简单，并且由于其插件的使用，可以轻松地将外部资源添加到项目中。
为了在 Hapi 框架中使用 OpenAPI，我们有两种选择：手工编写路由和处理函数并使用 OpenAPI 规范来描述 API，或使用 Hapi 安装 OpenAPI 插件完成描述和 API 版本控制工作。
使用手工编写路由的方式
下面是一个简单的 Hapi 路由和处理程序的示例，以及与之对应的 OpenAPI 规范定义：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ------ - --- -------------
----- ------------
----- ----
---
----- -------------- - --------- -- -- -
------ - ------ -------- --
--
--------------
------- ------
----- ---------
-------- ---------------
-------- -
----- --------
------------ ---- ----- ----- ---------
-------- -
--------------- -
---------- -
------ -
-------------- ----------- ----------
--------- - ------- ----------------------- -
-
-
-
-
-
---
---------------此处，我们手动定义了一个路由和一个处理函数。我们在路由选项中添加了一个 Hapi 插件：hapi-swagger。此插件为我们提供了 Swagger 自动文档和路由处理功能，使我们能够将路由和规范链接起来。
使用 Hapi 插件的方式
对于那些更喜欢快速轻松地将 OpenAPI 规范集成到 Hapi 中的人，Hapi Swagger 插件提供了一个选择。这个插件为我们提供了 自动路由和 Swagger 文档 生成功能，我们只需要创建规范并将其放入路由文件中，可以轻松地生成文档和路由处理。
下面是一个使用 Hapi Swagger 插件的示例：
-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- ------ - ------------------
----- ----------- - ------------------------
----- ---- - ---------------------
----- ------ - --- -------------
----- ------------
----- ----
---
----- ------ - -
-
------- ------
----- ----------------
-------- -------- --------- -- -
------ - ------ ---- --
--
-------- -
----- --------
-
-
--
----- -------------- - -
----- -
------ ----- --- ---------------
-
--
----- ------- - -
------
-------
-
------- ------------
-------- --------------
-
--
------ -- -- -
----- -------------------------
---------------------
----- ---------------
-----
在这个例子中，我们先添加了几个依赖，然后定义了一些路由。我们还定义了一些 Swagger 选项。最后，我们将这个插件实例化，并将其与其他插件一起注册到我们的应用程序中。
当我们通过 /documentation 访问文档时，它会提供我们一个自动生成的文档，其中包含有关我们应用程序中现有 API 的信息。
总结
OpenAPI 是一种可以描述 RESTful API 的标准。它将 API 定义为一系列易于读取和维护的 YAML 或 JSON 文档。Hapi 是一个现代的、可扩展的 Node.js Web 应用程序框架，可以让我们轻松创建和管理 API。使用 Hapi 和 OpenAPI 描述和管理您的 API 将会极大地方便开发人员和消费者，大大减少了项目工作的时间以及与其他团队之间定期的不必要的交流。在现代网络应用程序开发中，它们是一种不可或缺的工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64eead79f6b2d6eab38a39c1