a-pavithraa/springboot-skills-marketplace / plugins/springboot-architecture/skills/creating-springboot-projects
creating-springboot-projects
VerifiedUse when starting a new Spring Boot project or service: scaffolding or bootstrapping a backend, REST API, microservice or modular monolith; choosing how to structure it (layered, package-by-module, modular monolith, tomato, DDD-hexagonal); selecting Spring Boot 4 features; generating the base project with progen or Spring Initializr; or applying the bundled templates and references in this skill. Not for migrating existing projects or for isolated JPA/repository work without broader project-creation context.
assets/api-versioning-config.java
View on GitHubpackage {{PACKAGE}}.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.accept.SemanticApiVersionParser;
import org.springframework.web.servlet.config.annotation.ApiVersionConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* API Versioning Configuration (Spring Boot 4 / Spring Framework 7).
*
* Two equivalent configuration options:
* 1. Properties-based (recommended) - see application.yml below
* 2. Java configuration via WebMvcConfigurer.configureApiVersioning (shown here)
*
* Versioning strategies (pick one, or combine resolvers via useVersionResolver):
* 1. Request Header - useRequestHeader("X-API-Version")
* 2. Query Parameter - useQueryParam("version")
* 3. Media Type - useMediaTypeParameter(MediaType.APPLICATION_JSON, "version")
* 4. Path Segment - usePathSegment(index)
*
* Reference: https://docs.spring.io/spring-framework/reference/web/webmvc-versioning.html
*/
@Configuration
public class ApiVersioningConfig implements WebMvcConfigurer {
/**
* Java configuration (use this OR the properties below, not both).
*
* Spring Framework 7 wires the resolver, parser, supported versions, default
* version, and deprecation handler through ApiVersionConfigurer. There are no
* static factories like ApiVersionResolver.fromHeader(...) — call the
* configurer methods directly.
*/
@Override
public void configureApiVersioning(ApiVersionConfigurer configurer) {
configurer
.useRequestHeader("X-API-Version") // recommended strategy
// Alternative resolvers (uncomment one):
// .useQueryParam("version")
// .useMediaTypeParameter(MediaType.APPLICATION_JSON, "version")
// .usePathSegment(1)
.addSupportedVersions("1.0", "2.0")
.setDefaultVersion("1.0")
.setVersionParser(new SemanticApiVersionParser()); // optional — default
}
}
// ============================================================
// ALTERNATIVE: PROPERTIES-BASED CONFIGURATION (RECOMMENDED)
// ============================================================
//
// Instead of the @Configuration class above, configure via application.yml:
//
// spring:
// mvc:
// apiversion:
// default: "1.0"
// supported: "1.0,2.0"
// use:
// header: X-API-Version
// # path-segment: 1
// # query-parameter: version
// # media-type-parameter[application/json]: version
//
// Or application.properties:
// spring.mvc.apiversion.default=1.0
// spring.mvc.apiversion.supported=1.0,2.0
// spring.mvc.apiversion.use.header=X-API-Version
// ============================================================
// CONTROLLER WITH VERSIONED ENDPOINTS
// ============================================================
// package {{PACKAGE}}.{{MODULE}}.rest;
//
// import org.springframework.web.bind.annotation.*;
// import java.util.List;
//
// /**
// * Controller demonstrating API versioning.
// *
// * Same endpoint path, different behavior based on version.
// */
// @RestController
// @RequestMapping("/api/{{MODULE}}")
// public class {{NAME}}Controller {
//
// private final {{NAME}}Service service;
//
// public {{NAME}}Controller({{NAME}}Service service) {
// this.service = service;
// }
//
// /**
// * Version 1.0 - Returns simple list.
// */
// @GetMapping(value = "/search", version = "1.0")
// public List<{{NAME}}VM> searchV1(@RequestParam("q") String query) {
// return service.searchByTitle(query);
// }
//
// /**
// * Version 2.0 - Returns enriched data with additional fields.
// */
// @GetMapping(value = "/search", version = "2.0")
// public List<{{NAME}}EnrichedVM> searchV2(@RequestParam("q") String query) {
// return service.searchWithDetails(query);
// }
//
// /**
// * Version 3.0 - Returns paginated results.
// */
// @GetMapping(value = "/search", version = "3.0")
// public Page<{{NAME}}VM> searchV3(
// @RequestParam("q") String query,
// @RequestParam(defaultValue = "0") int page,
// @RequestParam(defaultValue = "20") int size
// ) {
// return service.searchPaginated(query, page, size);
// }
//
// /**
// * Endpoint without version - uses default version (1.0).
// */
// @GetMapping
// public List<{{NAME}}VM> findAll() {
// return service.findAll();
// }
// }
// ============================================================
// TESTING VERSIONED ENDPOINTS WITH RestTestClient
// ============================================================
// package {{PACKAGE}}.{{MODULE}}.rest;
//
// import org.junit.jupiter.api.BeforeEach;
// import org.junit.jupiter.api.Test;
// import org.springframework.beans.factory.annotation.Autowired;
// import org.springframework.boot.test.context.SpringBootTest;
// import org.springframework.test.web.servlet.client.RestTestClient;
// import org.springframework.web.client.ApiVersionInserter;
// import org.springframework.web.context.WebApplicationContext;
//
// import static org.assertj.core.api.Assertions.assertThat;
// import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
//
// @SpringBootTest(webEnvironment = RANDOM_PORT)
// class {{NAME}}ControllerTests {
//
// @Autowired
// private WebApplicationContext context;
//
// RestTestClient client;
//
// @BeforeEach
// void setup() {
// client = RestTestClient.bindToApplicationContext(context)
// .apiVersionInserter(ApiVersionInserter.useHeader("X-API-Version"))
// .build();
// }
//
// @Test
// void shouldUseDefaultVersion() {
// var result = client.get()
// .uri("/api/{{MODULE}}/search?q=test")
// .exchange()
// .expectStatus().isOk()
// .expectBody(List.class)
// .returnResult()
// .getResponseBody();
//
// assertThat(result).isNotNull();
// }
//
// @Test
// void shouldUseVersion2() {
// var result = client.get()
// .uri("/api/{{MODULE}}/search?q=test")
// .apiVersion("2.0")
// .exchange()
// .expectStatus().isOk()
// .expectBody(List.class)
// .returnResult()
// .getResponseBody();
//
// assertThat(result).isNotNull();
// }
// }
// ============================================================
// TESTING WITH MockMvcTester (Alternative)
// ============================================================
// package {{PACKAGE}}.{{MODULE}}.rest;
//
// import org.junit.jupiter.api.Test;
// import org.springframework.beans.factory.annotation.Autowired;
// import org.springframework.boot.test.context.SpringBootTest;
// import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
// import org.springframework.test.web.servlet.assertj.MockMvcTester;
// import org.springframework.test.web.servlet.assertj.MvcTestResult;
//
// import static org.assertj.core.api.Assertions.assertThat;
//
// @SpringBootTest
// @AutoConfigureMockMvc
// class {{NAME}}MockMvcTests {
//
// @Autowired
// MockMvcTester mvc;
//
// @Test
// void shouldTestWithVersion1() {
// MvcTestResult result = mvc.get()
// .uri("/api/{{MODULE}}/search?q=test")
// .apiVersion("1.0")
// .exchange();
//
// assertThat(result).hasStatusOk();
// }
// }
// ============================================================
// HTTP SERVICE CLIENT WITH VERSIONING
// ============================================================
// package {{PACKAGE}}.{{MODULE}}.client;
//
// import org.springframework.web.service.annotation.GetExchange;
// import org.springframework.web.service.annotation.HttpExchange;
// import java.util.List;
//
// /**
// * HTTP Service Client interface with versioned endpoints.
// */
// @HttpExchange
// public interface {{NAME}}Client {
//
// @GetExchange(url = "/api/{{MODULE}}/search", version = "1.0")
// List<{{NAME}}VM> searchV1(@RequestParam("q") String query);
//
// @GetExchange(url = "/api/{{MODULE}}/search", version = "2.0")
// List<{{NAME}}EnrichedVM> searchV2(@RequestParam("q") String query);
// }
//
// // Configuration remains the same:
// // @Configuration
// // @ImportHttpServices(group = "{{name}}", types = {{NAME}}Client.class)
// // public class ClientConfig { }
// ============================================================
// MIGRATION STRATEGY
// ============================================================
// When adding new API version:
// 1. Keep old version endpoints running (backwards compatibility)
// 2. Add new version with improved behavior
// 3. Document breaking changes in release notes
// 4. Deprecate old version after migration period
// 5. Remove deprecated version in next major release
//
// Example deprecation:
// @GetMapping(value = "/search", version = "1.0")
// @Deprecated(since = "2.0.0", forRemoval = true)
// public List<{{NAME}}VM> searchV1(@RequestParam("q") String query) {
// // Old implementation
// }
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |