Swagger UI：下拉版本选择

Question

我看到很多这样的图片，下拉菜单中有版本切换。显然这个东西应该只显示请求版本的路由（我们只能在屏幕截图上看到 V1 路由，但如果我们在下拉列表中切换到 V2 - 我们只会看到 V2 的路由）。

此“选择定义”功能是 OpenAPI 规范的一部分还是一些经过调整的 Swagger UI 实现？我怎样才能在 Swagger 编辑器中做这样的事情？我在 yaml 中找不到有关它的文档或示例。

Answer 1

以下是添加端点的方法。在 rswag_ui.rb 中

Rswag::Ui.configure do |c|
  c.swagger_endpoint '/api-docs/v1/swagger.yaml', 'API V1 Docs'
  c.swagger_endpoint '/api-docs/v2/swagger.yaml', 'API v2 Docs'
end

您可以通过这种方式指定哪个规范适用于哪个 API。通过添加 openapi_spec: 'v2/swagger.yaml' 或 swagger_root: 'v2/swagger.yaml 如果您的变量名称为 swagger_root 在 swagger_helper.rb 中。

RSpec.describe "Api::lcm::Assessments", openapi_spec: 'lcm/swagger.yaml', type: :request do
// your code
end

注意： 如果您使用 rspec-api 将 Swagger 文件（在 swagger_root 下）公开为 JSON 或 YAML 端点， 那么上面的列表应该对应于这些端点的相对路径