Class PathApiVersionResolver

java.lang.Object

org.springframework.web.accept.PathApiVersionResolver

All Implemented Interfaces:

ApiVersionResolver

public class PathApiVersionResolver
extends Object
implements ApiVersionResolver

ApiVersionResolver that extract the version from a path segment.

Note that this resolver will either resolve the version from the specified path segment, or raise an InvalidApiVersionException, e.g. if there are not enough path segments. It never returns null, and therefore cannot yield to other resolvers.

Since:

7.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
PathApiVersionResolver(int pathSegmentIndex)	Create a resolver instance.

Method Summary

Modifier and Type	Method	Description
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

PathApiVersionResolver

public PathApiVersionResolver(int pathSegmentIndex)

Create a resolver instance.

Parameters:

pathSegmentIndex - the index of the path segment that contains the API version

Method Details

resolveVersion

public 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