Swagger — набор инструментов вокруг OpenAPI. Документация строится из описания API, которое пишут вручную или генерируют из кода и аннотаций.
Что такое Swagger и за счёт чего формируется его автодокументация?
Swagger — набор инструментов вокруг OpenAPI. Документация строится из описания API, которое пишут вручную или генерируют из кода и аннотаций.
Короткий ответ
Что ответить на собеседовании
Подробный разбор
Ответ с пояснениями
Swagger — набор инструментов вокруг OpenAPI. Документация строится из описания API, которое пишут вручную или генерируют из кода и аннотаций.
OpenAPI описывает пути, методы, параметры, схемы данных, ответы и авторизацию. Swagger UI читает эту спецификацию и показывает интерактивную документацию. В конкретном backend её могут собирать из аннотаций, атрибутов или типизированных маршрутов. Само наличие Swagger не гарантирует актуальность: контракт нужно проверять относительно реального поведения API и обновлять вместе с кодом.
Источник: swagger.io.