Interface ApiVersionStrategy
- All Known Implementing Classes:
DefaultApiVersionStrategy
public interface ApiVersionStrategy
The main component that encapsulates configuration preferences and strategies
to manage API versioning for an application.
- Since:
- 7.0
- Author:
- Rossen Stoyanchev
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturn a default version to use for requests that don't specify one.void
handleDeprecations
(Comparable<?> version, ServerWebExchange exchange) Check if the requested API version is deprecated, and if so handle it accordingly, e.g.Comparable
<?> parseVersion
(String version) Parse the version of a request into an Object.default @Nullable Comparable
<?> Convenience method to return the parsed and validated request version, or the default version if configured.resolveVersion
(ServerWebExchange exchange) Resolve the version value from a request, e.g.void
validateVersion
(@Nullable Comparable<?> requestVersion, ServerWebExchange exchange) Validate a request version, including required and supported version checks.
-
Method Details
-
resolveVersion
Resolve the version value from a request, e.g. from a request header.- Parameters:
exchange
- the current exchange- Returns:
- the version, if present or
null
- See Also:
-
parseVersion
Parse the version of a request into an Object.- Parameters:
version
- the value to parse- Returns:
- an Object that represents the version
- See Also:
-
validateVersion
void validateVersion(@Nullable Comparable<?> requestVersion, ServerWebExchange exchange) throws MissingApiVersionException, InvalidApiVersionException Validate a request version, including required and supported version checks.- Parameters:
requestVersion
- the version to validateexchange
- the exchange- Throws:
MissingApiVersionException
- if the version is required, but not specifiedInvalidApiVersionException
- if the version is not supported
-
getDefaultVersion
@Nullable Comparable<?> getDefaultVersion()Return a default version to use for requests that don't specify one. -
resolveParseAndValidateVersion
Convenience method to return the parsed and validated request version, or the default version if configured.- Parameters:
exchange
- the current exchange- Returns:
- the parsed request version, or the default version
-
handleDeprecations
Check if the requested API version is deprecated, and if so handle it accordingly, e.g. by setting response headers to signal the deprecation, to specify relevant dates and provide links to further details.- Parameters:
version
- the resolved and parsed request versionexchange
- the current exchange- See Also:
-