GH-4024: Add documentation for the Version Route Predicate Factory#4205
Open
won-seoop wants to merge 1 commit into
Open
GH-4024: Add documentation for the Version Route Predicate Factory#4205won-seoop wants to merge 1 commit into
won-seoop wants to merge 1 commit into
Conversation
…e Factory
The Version predicate and its API versioning strategy configuration
(spring.webflux.apiversion.* / spring.mvc.apiversion.*) were never
documented after being added to both the WebFlux and WebMVC server
variants. This commit adds:
WebFlux (request-predicates-factories.adoc):
- How to configure the version resolution strategy (header, query
parameter, media-type parameter, path segment)
- Fixed-version and baseline-version (version+) examples
WebMVC (gateway-request-predicates.adoc):
- Same configuration guidance with spring.mvc.apiversion.*
- Java DSL example using GatewayRequestPredicates.version()
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #4024.
The
Versionroute predicate factory (and the companionversionpredicate in Gateway MVC) was added in #3865 and #4044 but documentation was never written. This PR adds it.What's documented
WebFlux (
request-predicates-factories.adoc)spring.webflux.apiversion.use.*(header, query parameter, media-type parameter, path segment)Version=1.3) and baseline-version match (Version=1.1+)ApiVersionStrategybean is presentWebMVC (
gateway-request-predicates.adoc)spring.mvc.apiversion.use.*Version=1.3) examplesGatewayRequestPredicates.version(String)Test plan
spring.webflux.apiversion/spring.mvc.apiversion)Version=1.3and baseline formVersion=1.1+are clearly distinguishedVersionRoutePredicateFactoryIntegrationTestsandPredicateIntegrationTests🤖 Generated with Claude Code