Я использую онлайн Редактор 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?