Swagger - это инструмент (фреймворк) для описания RESTful веб-сервисов.
Он реализует возможность создавать, документировать и использовать API, параметры запросов и ответы, а также форматы передачи данных.
На основе кода или набора правил Swagger автоматически генерирует документацию в формате JSON-файла. можно встроить на страницу сайта или в приложение.
Swagger или OpenAPI framework состоит из 4 основных компонентов:
- Swagger Core - позволяет генерировать документацию на основе существующего кода основываясь на Java Annotation.
- Swagger Codegen - позволит генерировать клиентов для существующей документации.
- Swagger UI - красивый интерфейс, который представляет документацию. Дает возможность просмотреть какие типы запросов есть, описание моделей и их типов данных.
- Swagger Editor - Позволяет писать документацию в YAML или JSON формата.
Swagger UI - позволяет визуализировать ресурсы API и взаимодействовать с ними без какой-либо логики реализации. Он автоматически генерируется из вашей спецификации OpenAPI (ранее известной как Swagger), а визуальная документация упрощает внутреннюю реализацию и использование на стороне клиента.
