npm 包 middleware-swagger-ui 使用教程

使用 swagger 可以方便地描述和测试 API 接口，而 middleware-swagger-ui 是一个方便的 npm 包，可以将 swagger UI 集成到 express 应用中。本文将会详细介绍如何安装、配置以及使用 middleware-swagger-ui 包，以及如何自定义一些配置和设置。

安装

首先您需要在 npm 中安装 middleware-swagger-ui 包。可以使用以下命令来进行安装：

npm install middleware-swagger-ui

集成到 Express 应用中

以下是如何将 middleware-swagger-ui 集成到 express 应用中的示例代码：

const express = require('express');
const swaggerUi = require('middleware-swagger-ui');
const swaggerDocument = require('./swagger.json');

const app = express();

app.use('/api', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

在这个例子中，swagger.json 文件中包含了 swagger 规范的定义。这个文件的路径需要自己定义，并且需要根据项目的需求进行编辑。

自定义设置

middleware-swagger-ui 中提供了许多配置选项，可以根据自己的需要进行自定义。以下是一些常用的配置选项：

• swaggerUrl - 可以设置 swagger 规范的 URL 地址
• swaggerJsonEndpoint - 可以设置 swagger 规范的 JSON 文件的路径
• explorer - 可以设置是否在 UI 中显示探索器
• customCssUrl - 可以设置 swagger UI 的 CSS 样式的 URL 地址
• customJsUrl - 可以设置 swagger UI 的 JS 脚本的 URL 地址

以下是一个完整的 middleware-swagger-ui 自定义配置的示例：

app.use('/api', swaggerUi.serve, swaggerUi.setup(swaggerDocument,
  {
    swaggerUrl: 'https://petstore.swagger.io/v2/swagger.json',
    explorer: true,
    customCssUrl: '/css/swagger-ui.css',
    customJsUrl: '/js/swagger-ui.js'
  }
));

使用这些配置选项可以让您更好地控制 swagger UI 的外观和行为。

结论

middleware-swagger-ui 可以让您将 swagger UI 集成到 Express 应用中，方便地为您的 API 接口提供文档和测试功能。通过本文的学习，您应该能够了解如何安装、配置以及使用 middleware-swagger-ui 包。同时，您也可以根据自己的需要自定义一些配置和设置，以满足项目的需求。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f481d8e776d0804111a