Как определить basePath в Swagger 2.0

Question

Изучая документацию по swagger, в частности аннотации, которые я не нашел, как определить свойства host и basePath. Есть идеи, где их установить?

согласованная документация: Форс-2.X --- Аннотации

Вот json, сгенерированный с переменными: petstore.swagger.io / v2 / swagger.json

Answer 1

Swagger 2.x поддерживает OpenAPI Спецификация 3.0 (см. здесь для справки), где host , basePath и В схемах ключевые слова заменены на элемент server .

В OpenAPI 3.0 вы можете использовать массив элементов server , чтобы указать один или несколько базовых URL-адресов для вашего API.

URL-адрес сервера имеет следующую структуру:

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

Вы можете зарегистрировать серверы, используя аннотацию @ Server :

• in @ OpenAPIDefinition (для всех операций)
• in @ Операция (для одной операции)

В качестве альтернативы вы можете определить серверы в вашем файле конфигурации Swagger например:

YAML

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

JSON

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