A Spring Boot example application.
- Java SE 21
This Spring Boot application provides CRUD (Create, Read, Update, Delete) operations via a REST API for an employee domain model. A JSON PATCH operation (partial update) is also supported whose JSON is defined by RFC (Request For Comments) 5261. The json-patch API implements the RFC and is used in the project to initiate partial updates. Refer to the article, Using JSON Patch in Spring, to learn more about creating the proper JSON for partial updates.
Upon application start-up an in-memory database (H2 database) is seeded with sample data. Verify the Spring Boot application is running by navigating to the below server address in your preferred browser.
localhost:8080/employees
You can also use curl in a terminal window: curl localhost:8080/employees
The application supports consuming/producing (request/response) both XML and JSON. Navigating to localhost:8080/employees from the browser will produce XML output. You can use tools such as Postman to execute the CRUD REST verbs (POST, GET, PUT, DELETE) while specifying different options (e.g., parameters, authorization, headers, request body, etc.). The application's PATCH implementation currently only supports consuming and producing JSON.
The application can be built via Maven in a couple of ways. Execute the below from the application's root folder via the terminal window.
- Create a JAR file without executing tests.
./mvnw package -DskipTests
- Execute tests and create a JAR file.
./mvnw package
The above will create a JAR file in the project's root folder's target directory.
Type the below command from a terminal window in the project's root folder.
MacOS/Linux
./mvnw spring-boot:run
Note: If mvnw is not executable run the below from the terminal window.
chmod +x mvnw
Windows
mvnw.bat spring-boot:run
You can also run the application, after it's built, by executing the below command from the terminal window.
java -jar <JAR file location> <fully qualified Spring Boot application class>