🚀 Hello, World! - RESTful Application

Minimal Spring Boot based RESTful 'Hello World' example, including Swagger.

Technology stack

Java 21, Spring Boot

Prerequisites

The following items should be installed in your system:

• Java 21 or newer.
• git command line tool (https://help.github.com/articles/set-up-git)
• Your preferred IDE (IDEA preferably)

Running locally

This application is a Spring Boot application built using Maven. You can build a jar file and run it from the command line:

git clone https://github.com/IQKV/quickstart-mvc-rest-hello-world.git
cd quickstart-mvc-rest-hello-world
./mvnw package
java -jar target/*.jar

You might also want to use Maven's spring-boot:run goal - applications run in an exploded form, as they do in your IDE:

./mvnw spring-boot:run -Dspring-boot.run.profiles=local -P dev

Now you can access to the Swagger UI here: http://localhost:8080/swagger-ui.html

Working with the Application in your IDE

1. On the command line

git clone https://github.com/IQKV/quickstart-mvc-rest-hello-world.git

2. Inside IDE

In the main menu, choose File -> Open and select the HelloWorldApplication pom.xml. Click on the Open button. Activate "local" profile in the Run settings or set it via environment variables. instruction Wait to indexing completion and push the green "play" button.

3. Navigate to Swagger UI

Visit http://localhost:8080/swagger-ui.html in your browser.

Code conventions

The code follows Google Code Conventions. Code quality is measured by:

• SonarQube
• PMD
• CheckStyle
• SpotBugs
• Qulice

Tests

This project contains JUnit tests, Hamcrest matchers, Mockito test doubles, Wiremock stubs, etc. You can run the test suite using

./mvnw verify -Puse-qulice

The minimum percentage of code coverage required for the workflow to pass is 80%.

Versioning

Project uses a three-segment CalVer scheme, with a short year in the major version slot, short month in the minor version slot, and micro/patch version in the third and final slot.

 YY.MM.MICRO

1. YY - short year - 6, 16, 106
2. MM - short month - 1, 2 ... 11, 12
3. MICRO - "patch" segment