在前端开发中，Swagger 是一种流行的 API 文档生成系统。通过使用 Swagger 可以帮助开发者更好的管理和文档化 API。而 SwaggerUI-Node 是一个基于 Node.js 的 npm 包，可以帮助我们在 Node.js 项目中集成 SwaggerUI，本篇文章将详细介绍如何使用 SwaggerUI-Node。
安装
使用 npm 可以简单方便地安装 SwaggerUI-Node。在你的项目目录下，运行以下命令：
npm install swaggerui-node --save
安装完成后，我们需要配置一些东西来使用它。
配置
在你的 Node.js 项目中，首先需要创建一个段代码，以引入 SwaggerUI-Node：
const express = require('express');
const swaggerUi = require('swaggerui-node');
const swaggerDocument = require('./swagger.json'); // 这里的路径配置为你项目中的实际 swagger.json 的位置接下来，我们需要配置 SwaggerUI-Node。在你的应用程序中，添加以下代码：
var options = { // 配置项
explorer: true,
swaggerOptions: {
validatorUrl: null
}
};
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));上述代码中，我们通过调用 swaggerUi.serve 和 swaggerUi.setup 两个函数来启动 SwaggerUI-Node。在配置项中，我们可以设置 UI 风格和 Validator URL。Validator URL 可以设置为 null，表示要跳过 SwaggerUI 中的验证。我们需要在项目中将 swaggerDocument 设置为你的 Swagger 规范的 JSON 文件，然后设置使用 swaggerUi 这个中间件。这里的路径配置为你项目中的实际 swagger.json 的位置。
使用
完成配置之后，我们就可以通过 http://localhost:port/api-docs 访问 API 文档了。此外，SwaggerUI 也支持在线编辑修改。因此，我们可以通过 SwaggerUI-Node 方便地管理 API 文档。
示例代码
这里提供一个示例代码帮助你更好的理解怎么集成 SwaggerUI-Node。以下代码使用 Express 框架完成集成：
-- -------------------- ---- -------
----- ------- - -------------------
----- --------- - --------------------------
----- --------------- - --------------------------
----- --- - ----------
--- ------- - - -- ---
--------- -----
--------------- -
------------- ----
-
--
------------ --------------------------------------- -- ------
-------------------- ---------------- -------------------------------- ---------- -- -- --------- --
----- ------ - ---------------- -------- -- -
------------------- -- --------- -- ---- --------
---在本代码示例中，SwaggerUI-Node 配置项中同样指定了 validatorUrl。
总结
通过本篇文章，我们了解了如何使用 SwaggerUI-Node 在 Node.js 项目中集成 SwaggerUI。这个 npm 包能够让我们更好地管理 API 文档并使其易于维护。希望这篇文章能帮助到你在日常开发中更好的发挥 Swagger 的优势。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f7b238a385564ab69fb