为什么外部文档在Swagger UI中的服务器之前出现?

问题描述 投票:0回答:1

我具有以下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: '[email protected]'
    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

swagger-ui openapi swagger-editor
1个回答
1
投票

[Swagger UI中infoexternalDocsservers部分的显示顺序是预定义的,并且不依赖于它们在YAML / JSON文件中的顺序。

但是,默认情况下,servers中的各个服务器,paths中的各个路径和操作以及模式中的各个属性的显示顺序与它们在API定义中列出的顺序相同。

© www.soinside.com 2019 - 2024. All rights reserved.