Swagger — это экосистема инструментов для работы с API. Она помогает проектировать, описывать, документировать и проверять интерфейсы взаимодействия между приложениями.

API можно представить как договор между двумя системами. В этом договоре указывается:

• по какому адресу система принимает запрос;
• какой HTTP-метод используется;
• какие параметры необходимо передать;
• в каком формате передаются данные;
• какой ответ вернётся при успешной обработке;
• какие ошибки возможны;
• каким образом выполняется авторизация;
• какие ограничения действуют для запросов.

Описание API обычно хранится в файле формата YAML или JSON. Этот файл читают как люди, так и специальные инструменты. Благодаря этому одна и та же спецификация может использоваться для подготовки документации, проверки API, генерации кода и согласования требований между аналитиками, разработчиками и тестировщиками.

Swagger — это название набора инструментов, которые работают с OpenAPI-описаниями. К основным инструментам относятся:

• Swagger Editor — создание и редактирование OpenAPI-файлов;
• Swagger UI — визуальное отображение интерактивной документации;
• Swagger Codegen — генерация клиентских библиотек, серверных заготовок и документации;
• коммерческие продукты SwaggerHub и другие инструменты экосистемы.

Зачем Swagger нужен аналитику?
Для бизнес-аналитика Swagger помогает перевести бизнес-требования в понятный технический интерфейс.
Для системного аналитика Swagger является одним из основных способов описания интеграций.