Документирование API с помощью Swagger/OpenAPI
OpenAPI (ранее Swagger) — отраслевой стандарт для описания REST API. Библиотека springdoc-openapi автоматически генерирует спецификацию OpenAPI 3.0 JSON/YAML из ваших Spring MVC контроллеров и предоставляет интерактивный Swagger UI по адресу /swagger-ui.html — без какой-либо конфигурации. Аннотации позволяют обогатить сгенерированную документацию описаниями, примерами и схемами безопасности.