带有API版本控制的Swagger UI Express

问题描述 投票:0回答:1

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

enter image description here

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

期待您的回复。

node.js swagger swagger-ui api-versioning
1个回答
0
投票

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

const swaggerOptions = {
  explorer: true,
  swaggerOptions: {
    urls: [
      {
        url: 'https://v1/swagger.json',
        name: 'v1'
      },
      {
        url: 'https://v2/swagger.json',
        name: 'v2'
      }
    ]
  }
}
© www.soinside.com 2019 - 2024. All rights reserved.