rrezartprebreza/spring-boot-skills / skills/spring-boot-4/api-versioning
api-versioning
VerifiedUse when versioning Spring MVC or WebFlux APIs in Spring Boot 4 / Spring Framework 7. Covers built-in mapping versions, request version resolution, defaults, supported versions, and deprecation headers.
API Versioning (Boot 4 / Framework 7)
Spring Framework 7 provides API versioning in the mapping layer. Prefer it over hand-rolled
/v1 prefixes, custom HandlerMapping implementations, or version-sniffing filters.
Declare versions on mappings
@RestController
@RequestMapping("/api/orders")
class OrderController {
@GetMapping(path = "/{id}", version = "1.0")
OrderV1 getV1(@PathVariable UUID id) { ... }
@GetMapping(path = "/{id}", version = "1.2")
OrderV2 getV2(@PathVariable UUID id) { ... }
}
Use semantic version strings. A + suffix means the mapping handles that version and newer
versions, for example version = "1.2+".
Configure one request resolution strategy
@Configuration
class WebConfig implements WebMvcConfigurer {
@Override
public void configureApiVersioning(ApiVersionConfigurer configurer) {
configurer
.useRequestHeader("API-Version")
.setDefaultVersion("1.0")
.addSupportedVersions("1.0", "1.2");
}
}
Choose exactly one source: request header, query parameter, path segment, or media-type
parameter. Keep the choice consistent across the application. WebFlux uses the corresponding
WebFluxConfigurer hook.
Required behavior and deprecation
Versioning is required unless a default is configured or setVersionRequired(false) is used.
Missing or unsupported versions should be covered by the API error contract. Use
StandardApiVersionDeprecationHandler for Deprecation, Sunset, and Link response headers.
Boot properties can provide defaults under spring.mvc.apiversion.* or
spring.webflux.apiversion.*, but keep the resolution strategy in Java configuration when its
behavior must be explicit.
Gotchas
- Agent hand-rolls
/api/v1prefixes or a version filter - use the mappingversionattribute. - Agent writes
version = 1- the value is a semantic versionString, such as"1.0". - Agent uses
useHeaderoruseQueryParameter- useuseRequestHeaderoruseQueryParam. - Agent enables versioning without a default or
versionRequired(false)- un-versioned requests return 400. - Agent mixes a path segment and a request header - choose one source of truth.
- Agent invents custom sunset headers - use
StandardApiVersionDeprecationHandler.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementation | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirements | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |