前言
@loopback/openapi-v3 是基于 OpenAPI 3.0.0 规范的 LoopBack 应用程序和 REST API 的生成器。该包提供了一个 OpenAPI 规范文档（原 Swagger ）的完整实现。
在本文中，我将提供使用 @loopback/openapi-v3 包的详细步骤，让您能够快速了解如何使用它来生成 OpenAPI 规范文档。
环境要求
在开始学习使用 @loopback/openapi-v3 包前，你必须先安装 Node.js 环境。您可以从官网https://nodejs.org/下载 Node.js 的安装文件。
安装 @loopback/openapi-v3
安装 @loopback/openapi-v3 包非常简单，只需要运行以下 npm 命令即可：
--- ------- ------ --------------------
这个命令将 @loopback/openapi-v3 包安装到你的项目中，并将其添加到 package.json 中的 dependencies 中。
创建一个基本 LoopBack 应用
在使用 @loopback/openapi-v3 之前，你需要先创建一个 LoopBack 应用。
你可以使用以下命令来创建一个 LoopBack 应用：
--- ---
创建完成后，您需要使用以下命令进入应用程序的目录：
-- --------
在应用程序根目录下创建一个新文件 datasources.json：
-
----- -
------------ --------
-
-这里使用了 LoopBack 4 的 memory 连接器，但你也可以根据自己的需要配置其他类型的数据库连接器。
创建一个 REST API
现在，让我们创建一个简单的 REST API，用于将数据存储在内存中。
首先，创建一个新的 model：
--- -----
接下来，我们将创建一个控制器 controller，它将处理来自客户端的请求，并使用 repository 将数据存储在一个内存中的数组中。
--- ----------
确保你在上面的控制器中引入了 repository 和 model，并为你的 API 路径设置正确的装饰器。
------ ------------ ---- -----------------------
------ ------ ------ ------------ ---- -----------------
------ ------------------ ---- -----------------
------ ------------------ ---- ------------------
------ -------- ---- ------------
------ ----- ---------------- -
------------
-----------------------------
------ ----------------- -----------------
- --
----------------
----- --------------------- ------- -------- --------------- -
------ ----- -------------------------------------
-
-生成 OpenAPI 规范文档
现在，我们已经创建了 LoopBack 应用和 REST API。接下来，我们需要使用 @loopback/openapi-v3 包来生成我们的 OpenAPI 规范文档。
打开你的 src/application.ts，并将以下代码添加到 main 函数中：
------ ------------- ---- -----------------------
------ -------------- ---- -----------------------
------ - -- -- ---- -----
------ - -- ---- ---- -------
----- --------------- - -------------------- --------------------------
------ ----- ------------- ------- --------------------------------------------------------- -
-------------------- ----------------- - --- -
-- ---
-
----- ------------- ----------------- - --- -
-- ---
----- ----- ----------- - ----- -------------------------- -
-- ---- ------- ---- ------- ----
---
--------------------------------- -------------------- ----- ----
-- ---
-
-这里使用了 generateSpec() 方法来生成 OpenAPI 规范文档，该方法需要接受 this.options 对象，其中包含应用程序的配置选项。你也可以传递其他选项，如你的文档标题和版本号等。
此外，在 MyLoopbackApp 类的构造函数中，你需要在 basePath 属性中设置你的文档路由。例如：
---------------------
现在，运行应用程序：
--- -----
一旦你运行了应用程序，它将自动将生成的 OpenAPI 规范文档写入 public 文件夹下的 openapi.json 文件中。
测试 OpenAPI 规范文档
现在，你已经成功地使用 @loopback/openapi-v3 包生成了你的 OpenAPI 规范文档。你可以使用 Swagger UI 或其他 OpenAPI 文档工具来测试这个文档。
如果使用的是 Swagger UI，请打开 http://localhost:3000/explorer/ 并点击右上角的 Explore 按钮。你应该能够看到你的 REST API 的文档，如下所示：
结论
通过本文，你已经学会了如何使用 @loopback/openapi-v3 包来生成 OpenAPI 规范文档。它不仅可以帮助你轻松地生成文档，还可以让你更好地管理你的 REST API。
希望这篇文章对你有所帮助。如有任何问题或建议，请在评论区留言。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedab62b5cbfe1ea061076c