Что это?
Набор инструментов, которые помогают описывать API.
Можно на основе кода автоматически сгенерировать спецификации API.
Благодаря ему пользователи и машины лучше понимают возможности REST API без доступа к коду.
С помощью Swagger можно быстро создать документацию и отправить ее другим разработчикам или клиентам.
В 2015 году проект Swagger сделали открытым и передали OpenAPI Initiative. Теперь сама спецификация называется OpenAPI. Swagger — инструментарий для работы с OpenAPI, название которого используется в коммерческих и некоммерческих продуктах.
Документ спецификации OpenAPI использует YAML, но также может быть написан в формате JSON. Сам по себе он является объектом JSON.
Swagger предлагает два основных подхода к генерированию документации:
- Автогенерация на основе кода.
- Самостоятельная разметка-написание.
- Описания можно готовить в формате YAML/JSON.
- Можно упростить эту задачу, используя Swagger Editor.
Ссылки