Почему внешние документы отображаются перед серверами в интерфейсе Swagger? - PullRequest
Новая
       33

Почему внешние документы отображаются перед серверами в интерфейсе Swagger?

0 голосов
/ 03 марта 2020

У меня есть следующее определение OpenAPI YAML. Раздел externalDocs находится под разделом servers, но он отображается перед сервером в предварительном просмотре в редакторе Swagger (https://editor.swagger.io/). Почему это так? 

openapi: 3.0.0
info:
  title: Service
  description: >- 
    Service description
  version: '1.0'
  termsOfService: >-
    https://pdf/API_Developer_Agreement.pdf
  contact:
    email: 'contact@contact.com'
    name: 'contact Europa'
servers:
  - url: http://api.example.com/v1
    description: Optional server description, e.g. Main (production) server
  - url: http://staging-api.example.com
    description: Optional server description, e.g. Internal staging server for testing
externalDocs:
  description: "externalDocs"
  url: 'https://externalDocs'

paths:
  /users:
    get:
      summary: Returns a list of users.
      description: Optional extended description in CommonMark or HTML
      responses:
        '200':
          description: A JSON array of user names
          content:
            application/json:
              schema: 
                type: array
                items: 
                  type: string

enter image description here

1 Ответ

1 голос
/ 03 марта 2020

Порядок отображения секций info, externalDocs и servers в пользовательском интерфейсе Swagger задан заранее и не зависит от их порядка в файле YAML / JSON.

Однако отдельные серверы в servers, отдельные пути и операции в paths, а также отдельные свойства в схемах по умолчанию отображаются в том же порядке, в котором они перечислены в определении API.

...