带有 API 版本控制的 Swagger UI Express

Question

我正在使用 swagger-ui-express 和 swagger-jsdoc 作为 API 我的节点应用程序的文档。这里的要点是我的应用程序中有两个版本的 API，我想记录这两个版本。我已经看到在 .NET Core 中有一个选项可用于定义规范并从顶部栏的下拉列表中选择一个。我正在寻找类似的解决方案

由于在顶部栏中可以看到下拉菜单，我希望通过 swagger-ui-express 获得类似的内容。是否有可能，或者是否有人已经为 API 版本控制实施了相同的方法？

期待您的回复。

Answer 1

我提出的解决方案并不特定于 API 版本控制，但您可以有一个 URL 下拉列表，最终用户可以从中进行选择。根据 docs，您需要传递一个 swaggerOptions 对象：

const swaggerOptions = {
  explorer: true,
  swaggerOptions: {
    urls: [
      {
        url: 'https://v1/swagger.json',
        name: 'v1'
      },
      {
        url: 'https://v2/swagger.json',
        name: 'v2'
      }
    ]
  }
}