Подтвердить что ты не робот

Как указать примеры параметров 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, я получаю сообщение об ошибке:

не является точно одним из < #/определений/параметров > , < #/определений/jsonReference >

Как установить пример при записи параметров GET в Swagger?

4b9b3361

ОТВЕТЫ

Ответ 1

OpenAPI 2.0

OpenAPI/Swagger 2.0 не имеет example ключевого слова для параметров, не связанных с телом. Вы можете указать примеры в 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

Примеры параметров изначально поддерживаются в 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