Създаването на документация нужна на нашето Rest Api приложение би било трудоемко, но за наш късмет, в рамките на Spring Framework това е доста лесно. За целта към нашият pom файл добавяме следната зависимост (Примерът е за Spring 3+ версии):
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.5.0</version>
</dependency>
След като запишем промените ние може да видим информация на следните линкове за нашето приложение:
http://localhost:8080/swagger-ui/index.html -> показва визуална документация
http://localhost:8080/v3/api-docs -> показва документация под формата на JSON
Важно е да се отбележе, че в линковете се ползва порт по подразбиране за Spring Web, който е 8080. Ако ползвате друг, трябва да зададете актуалния порт. Ако все пак нещата не се получават помислете дали нямате някакви ограничения породени от Spring Security или други зависимости.