This is a sample project that leverages the Spring Fox / Spring Doc library to automatically generate API documentation in a Spring Boot application.
- Java 20
- Spring Boot
- Spring Fox / Spring Doc (Swagger Documentation)
- Maven
- Clone the repository.
- Run the command
mvn clean install
in the project root to download dependencies and compile the code. - Run the command
mvn spring-boot:run
to start the application.
With the application running, access the URL http://localhost:8080/swagger-ui.html to explore the documentation generated by Spring Fox.
Configuration of Spring Fox / Spring Doc is done through annotations in the application controllers. You can define information such as the API title, description, version, available endpoints, among others.