spring-boot-skill

name

spring-boot-skill

description

Build Spring Boot 4.x applications following the best practices. Use these guidelines when developing Spring Boot applications that use Spring MVC, Spring Data JPA, Spring Modulith, Spring Security. Use these guidelines to create recommended Spring Boot package structure. Use these best practices while implementing REST APIs, entities/repositories, service layer, modular monoliths. Use these guidelines while writing tests for REST APIs and Web applications. Configure the recommended plugins and configurations to improve code quality, and testing while using Maven. Use these guidelines to use Spring Boot's Docker Compose support for local development. Use Taskfile for easier execution of common tasks while working with a Spring Boot application.

Spring Boot Skill

Apply the practices below when developing Spring Boot applications. Read the linked reference only when working on that area.

Maven pom.xml Configuration

Read references/spring-boot-maven-config.md for Maven pom.xml configuration with supporting plugins and configurations to improve code quality, and testing.

Package structure

Read references/code-organization.md for domain-driven, module-based package layout and naming conventions.

Spring Data JPA

Implement the repository and entity layer using references/spring-data-jpa.md.

Service layer

Implement business logic in the service layer using references/spring-service-layer.md.

Spring MVC REST APIs

Implement REST APIs with Spring MVC using references/spring-webmvc-rest-api.md.

Spring Modulith

Build a modular monolith with Spring Modulith using references/spring-modulith.md.

REST API Testing

If building a REST API using Spring WebMVC, test Spring Boot REST APIs using references/spring-boot-rest-api-testing.md.

Web App Controller Testing

If building a web application using view rendering controllers, test the controller layer using references/spring-boot-webapp-testing-with-mockmvctester.md.

Spring Boot Docker Compose Support

To use Docker Compose support for local development, refer references/spring-boot-docker-compose.md.

Taskfile

Use references/taskfile.md for easier commands execution.