1. Обзор
Документация является неотъемлемой частью создания REST API. В этом руководстве мы рассмотрим SpringDoc — инструмент, который упрощает создание и обслуживание документации по API на основе спецификации OpenAPI 3 для приложений Spring Boot 1.x и 2.x.
2. Настройка springdoc-openapi
Чтобы springdoc-openapi автоматически генерировал документы спецификации OpenAPI 3 для нашего API, мы просто добавляем зависимость springdoc-openapi-ui
в наш pom.xml
: