带有API版本控制的Swagger UI Express

时间:2020-06-09 17:35:17

标签: node.js swagger swagger-ui api-versioning

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

enter image description here

在顶部栏中可以看到一个下拉菜单,我想通过swagger-ui-express进行类似操作。是否有可能或是否有人为API版本控制实现了相同的功能?

期待您的回复。

1 个答案:

答案 0 :(得分:1)

我建议的解决方案并不特定于API版本控制,但是您可以从下拉列表中找到最终用户可以选择的URL。根据{{​​3}},您需要传递一个swaggerOptions对象:

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