Getting Started

Reference Documentation

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image
• Spring Web

Guides

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring

Maven Parent overrides

Due to Maven's design, elements are inherited from the parent POM to the project POM. While most of the inheritance is fine, it also inherits unwanted elements like <license> and <developers> from the parent. To prevent this, the project POM contains empty overrides for these elements. If you manually switch to a different parent and actually want the inheritance, you need to remove those overrides.

Running the Server

To start the application server, use the following Maven command:

mvn spring-boot:run

This will compile the project (if necessary) and launch the Spring Boot application. By default, the server will be available at http://localhost:8080.

Running Unit Tests

To execute the unit tests for the project, run:

mvn test

This will compile and run all tests in the project, displaying the results in the console.

Important to know

The following was discovered as part of building this project:

• The original package name 'com.example.spring-java-method-challenge' is invalid and this project uses 'com.example.spring_java_method_challenge' instead.