Swagger Несколько примеров не отображаются - PullRequest
0 голосов
/ 01 октября 2018

Когда я добавляю примеры в свой документ по swagger и проверяю его в редакторе swagger, он никогда нигде не отображается.Может ли кто-нибудь дать мне пример того, где несколько примеров фактически отображаются где-либо?

Вот пример того, как добавлено несколько примеров: enter image description here

это из: https://swagger.io/docs/specification/adding-examples/

Вот пример yaml, который не отображает examples в онлайн-редакторе swagger:

openapi: 3.0.0
info:
  title: Some API
  version: 1.0.0
paths:
  /logon:
    get:
      summary: Login user
      tags:
        - '/logon'
      parameters:
        - name: Client
          in: query
          required: true
          examples:
            zero:
              value: '0'
              summary: A sample limit value
            max:
              value: '50'
              summary: A sample limit value
          schema:
            type: string
      responses:
        '200':
          description: Success response

1 Ответ

0 голосов
/ 01 октября 2018

Несколько examples отображаются в Swagger UI 3.23.0+ и Swagger Editor 3.6.21 +:

Swagger UI displays multiple examples using a drop-down list

В старых версиях вы можете использовать один example в качестве обходного пути:

      parameters:
        - name: Client
          in: query
          required: true
          example: '50'  # <-----
          schema:
            type: string
...