简体   繁体   English

Swagger UI Express 与 API 版本控制

[英]Swagger UI Express with API Versioning

I am using swagger-ui-express and swagger-jsdoc for API Documentation of my node app.我正在为我的节点应用程序的 API 文档使用 swagger-ui-express 和 swagger-jsdoc。 The point here is that I have two versions of API in my App and I want to document both of them.这里的重点是我的应用程序中有两个版本的 API,我想记录它们。 I have seen that in .NET Core there is an option available to define the specs and choose one from a dropdown in top bar.我已经看到在 .NET Core 中有一个选项可用于定义规格并从顶部栏中的下拉列表中选择一个。 I am looking for a similar solution我正在寻找类似的解决方案

在此处输入图像描述

As a dropdown can be seen in top bar I want similar via swagger-ui-express.由于可以在顶部栏中看到一个下拉列表,我希望通过 swagger-ui-express 进行类似的操作。 Is it possible or if anybody has implemented the same for API Versioning?是否有可能或者是否有人为 API 版本控制实现了相同的功能?

Looking forward to your responses.期待您的回复。

The solution I propose is not specific to API versioning, but you can have a dropdown of URLs the end-user can choose from.我提出的解决方案并不特定于 API 版本控制,但您可以有一个最终用户可以选择的 URL 下拉列表。 According to the docs , you would need to pass a swaggerOptions object:根据文档,您需要传递一个swaggerOptions object:

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

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM