Skip to content

eliezerjg/spring-sample-project-openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 Documentation Project Using Spring Boot and Open API Documentation Imple.

This is a sample project that leverages the Spring Fox / Spring Doc library to automatically generate API documentation in a Spring Boot application.

🚀 Technologies Used

  • Java 20
  • Spring Boot
  • Spring Fox / Spring Doc (Swagger Documentation)
  • Maven

🛠️ Installation

  1. Clone the repository.
  2. Run the command mvn clean install in the project root to download dependencies and compile the code.
  3. Run the command mvn spring-boot:run to start the application.

🚀 Usage

With the application running, access the URL http://localhost:8080/swagger-ui.html to explore the documentation generated by Spring Fox.

⚙️ Configuration

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.

About

A basic implementation using OPENAPI (Swagger)

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages