如何在 swagger 2.0 中定义 basePath

【问题标题】：How to define basePath in swagger 2.0如何在 swagger 2.0 中定义 basePath
【发布时间】：2018-09-13 20:34:57
【问题描述】：

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

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

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

【问题讨论】：

【解决方案1】：

Swagger 2.x 支持 OpenAPI Specification 3.0（参见 here 以供参考），其中 host、basePath 和 schemes 关键字已被 server 元素替换。

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

服务器 URL 具有以下结构：

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

您可以使用注解@Server注册服务器：

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

YAML

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

JSON

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

【讨论】：