swagger-ui - 如何在 swagger 2.0 中定义 basePath

Question

查看 swagger 文档，特别是我没有找到如何定义 host 和 basePath 属性的注释。
知道在哪里设置它们吗？

查阅的文档:
Swagger-2.X---Annotations

这是使用变量生成的 json:
petstore.swagger.io/v2/swagger.json

Answer 1

Swagger 2.x 支持 OpenAPI 规范 3.0 (请参阅 here 以供引用)，其中 host、basePath 和 Scheme 关键字已被 server 元素替换。

在 OpenAPI 3.0 中，您可以使用一组服务器元素来为您的 API 指定一个或多个基本 URL。

服务器 URL 具有以下结构:

    scheme://host[:port][/basePath]

您可以使用注释 @Server 注册服务器:

在 @OpenAPIDefinition (适用于所有操作)

在 @Operation (单次操作)

或者，您可以在 Swagger configuration file 中定义服务器例如:

YAML

servers:
- url: https://api.example.com/v1
  description: example

JSON

  "servers" : [ {
    "url" : "https://api.example.com/v1",
    "description" : "example"
  } ]