Как указать примеры для параметров GET в Swagger?

Я использую онлайн Редактор Swagger чтобы создать спецификацию Swagger для моего API.

мой API имеет одну конечную точку запроса GET, и я использую следующий код YAML для описания входных параметров:

paths:
  /fooBar:
    get:
      tags:
        - foobar
      summary: ''
      description: ''
      operationId: foobar
      consumes:
        - application/x-www-form-urlencoded
      produces:
        - application/json
      parameters:
        - name: address
          in: query
          description: Address to be foobared
          required: true
          type: string
          example: 123, FakeStreet
        - name: city
          in: query
          description: City of the Address
          required: true
          type: string
          example: New York

Если я положу в example тег, я получаю сообщение об ошибке сказав:

не совсем один из ,

Как установить пример при написании GET параметры в куражиться?

8
openapi swagger swagger-2.0 swagger-editor

1 ответов

OpenAPI / Swagger 2.0 не имеет example ключевое слово для параметров non-тела. Примеры можно указать в параметре description. Некоторые инструменты, такие как Swagger UI v2, v3.12+ и Dredd также поддерживают x-example свойства расширения для этой цели:

      parameters:
        - name: address
          in: query
          description: Address to be foobared. Example: `123, FakeStreet`.  # <-----
          required: true
          type: string
          x-example: 123, FakeStreet   # <-----

примеры параметров поддерживаются изначально в OpenAPI 3.0:

      parameters:
        - name: address
          in: query
          description: Address to be foobared
          required: true
          schema:
            type: string
            example: 123, FakeStreet   # <----
          example: 456, AnotherStreet  # Overrides schema-level example
17