Example Project

Spring Boot 2.7.5 & Open API 3

Related Article:

https://ruuben.medium.com/documenting-spring-boot-2-5-x-apis-using-openapi-3-0-6334984c6744

Build guide

Gradle

Testing

First check that you are able to compile and pass the tests:

./gradlew test

For test report and code coverage:

open build/reports/tests/test/index.html

./gradlew build jacocoTestReport
open build/reports/jacoco/test/html/index.html

Start

To run the backend API locally:

./gradlew bootRun

Otherwise, to build it as a fat jar and execute it:

./gradlew bootJar
java -jar build/libs/spring-boot-junit5-example-1.0-SNAPSHOT.jar

Maven

Testing

First check that you are able to compile and pass the tests:

mvn clean test

For test report and code coverage:

mvn surefire-report:report
open target/site/surefire-report.html

mvn jacoco:report
open target/site/jacoco/index.html

Start

To run the backend API locally:

mvn spring-boot:run

Otherwise, to build it as a fat jar and execute it:

mvn clean install 
java -jar target/spring-boot-junit5-1.0-SNAPSHOT.jar

Server check

To access to the database (H2) on dev mode:

open http://localhost:8080/h2-console 

API Documentation (Swagger):

open http://localhost:8080/v3/api-docs
open http://localhost:8080/swagger-ui.html