SA Шпаргалка

Все ответы в 2 клика

Средний

Как в OpenAPI (Swagger) описать массив объектов?

Для описания массива в YAML-файле OpenAPI используется тип array, а внутри него ключевое слово items, которое указывает на тип элементов массива.

Пример (массив строк):

type: array
items:
type: string

Пример (массив сложных объектов):

type: array
items:
ref: '#/components/schemas/User'

(Примечание: перед ref обычно ставится спецсимвол, но суть в ссылке на переиспользуемую схему).
✅ Итог: Это позволяет фронтенду и бэкенду точно знать, что в ответе придет список пользователей, а не один объект.

Другие вопросы темы «Документация API»

Ещё вопросы раздела «Документация»

Все вопросы раздела «Документация»