Class MediaTypeParamApiVersionResolver

java.lang.Object

org.springframework.web.accept.MediaTypeParamApiVersionResolver

All Implemented Interfaces:

ApiVersionResolver

public class MediaTypeParamApiVersionResolver
extends Object
implements ApiVersionResolver

ApiVersionResolver that extracts the version from a media type parameter found in the Accept or Content-Type headers.

Since:

7.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
MediaTypeParamApiVersionResolver(MediaType compatibleMediaType, String paramName)	Create an instance.

Method Summary

Modifier and Type	Method	Description
@Nullable String	resolveVersion(jakarta.servlet.http.HttpServletRequest request)	Resolve the version for the given request.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MediaTypeParamApiVersionResolver

public MediaTypeParamApiVersionResolver(MediaType compatibleMediaType,
 String paramName)

Create an instance.

Parameters:

compatibleMediaType - the media type to extract the parameter from with the match established via MediaType.isCompatibleWith(MediaType)

paramName - the name of the parameter

Method Details

resolveVersion

public @Nullable String resolveVersion(jakarta.servlet.http.HttpServletRequest request)

Description copied from interface: ApiVersionResolver

Resolve the version for the given request.

Specified by:

resolveVersion in interface ApiVersionResolver

Parameters:

request - the current request

Returns:

the version value, or null if not found