Swagger UI Express带有API版本控制

3
我正在使用swagger-ui-express和swagger-jsdoc来为我的node应用程序编写API文档。重点在于,我的应用程序有两个版本的API,我想为它们都编写文档。我看到在.NET Core中有一个选项可以定义规范,并从顶部栏中的下拉菜单中选择一个。我正在寻找类似的解决方案。

enter image description here

作为一个下拉菜单可以在顶部栏中看到,我希望通过swagger-ui-express实现类似的功能。这可能吗?或者是否有人已经为API版本控制实现了相同的功能?期待您的回复。

这些链接都没有回答问题。我不是在谈论多个主机的问题。你提供的链接https://github.com/OAI/OpenAPI-Specification/issues/408中有答案吗?请仔细阅读问题。 - Manoj Sethi
1
感谢你所付出的努力,但是那并没有帮到我。下面的答案已经满足了我的需求。 - Manoj Sethi
1个回答

3
我提出的解决方案不仅适用于API版本控制,而且可以让最终用户选择下拉菜单中的URL。根据文档,您需要传递一个swaggerOptions对象:
const swaggerOptions = {
  explorer: true,
  swaggerOptions: {
    urls: [
      {
        url: 'https://v1/swagger.json',
        name: 'v1'
      },
      {
        url: 'https://v2/swagger.json',
        name: 'v2'
      }
    ]
  }
}

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接