Обязательные параметры в запросе не отмечены в пользовательском интерфейсе - PullRequest
Новая
       39

Обязательные параметры в запросе не отмечены в пользовательском интерфейсе

0 голосов
/ 08 мая 2019

Я отметил в своем файле параметров yaml: 

     parameters:
     - name: someID
       in: query
       description: The some ID
       required: true
       schema:
        type: uuid

В сгенерированных классах Java поле помечено как обязательное, и это здорово, но, к сожалению, в Swagger UI этого нет.Это проблематично, потому что я хотел бы сообщить пользователю перед неудачным запросом, что этот файл требуется.

1 Ответ

1 голос
/ 08 мая 2019

В OpenAPI 2.0 (swagger: '2.0') параметры запроса не используют schema и используют ключевое слово type напрямую.Обратите внимание, что нет type: uuid, вместо этого вам нужно type: string + format: uuid: 

parameters:
  - name: someID
    in: query
    description: The some ID
    required: true
    type: string
    format: uuid

Swagger UI указывает необходимые параметры, отображая красную заметку * required рядом симя параметра:

How required parameter is indicated in Swagger UI

...