Что такое Swagger

набор инструментов, который упрощает разработку API в соответствии со стандартом Swagger Specification (до 2015 года) / OpenAPI Specification (с 2016 года). Он помогает в автоматизации работы с документацией, а также тестировании и создании серверного кода.

В базовом варианте описание API (на основе которого работают инструменты Swagger) представляет из себя один файл, как правило, openapi.yaml или openapi.json. В нем описываются возможности API, позволяя как людям, так и компьютерам понимать, как взаимодействовать с ним.

Инструменты Swagger:

• Swagger UI — визуальная интерактивная документация.
• Swagger Editor — редактор спецификаций.
• Swagger Codegen — генератор шаблона серверного кода, а также клиентских библиотек (SDK) на разных языках.
• Swagger Hub — облачная платформа.

Минимальный набор, который позволит документировать API с помощью Swagger — это файл openapi.yaml + Swagger UI. Последний можно запустить в виде приложения docker или установить как набор статических файлов, развернув их на веб-сервере. Однако, для полноценного создания API также требуется написание кода на стороне сервера.

Подробнее о Swagger на Википедии.