Package org.springdoc.core.versions

Class PathVersionStrategy

java.lang.Object

org.springdoc.core.versions.SpringDocVersionStrategy

org.springdoc.core.versions.PathVersionStrategy

public class PathVersionStrategy
extends SpringDocVersionStrategy

The type Path version strategy.

Author:

bnasslahsen

Field Summary

Fields inherited from class org.springdoc.core.versions.SpringDocVersionStrategy

defaultVersion, version, versionDefaultMap

Constructor Summary

Constructors

Constructor	Description
PathVersionStrategy(int pathSegmentIndex, String defaultVersion)	Instantiates a new Path version strategy.

Method Summary

Modifier and Type	Method	Description
int	getPathSegmentIndex()	Gets path segment index.
String	updateOperationPath(String operationPath, String version)	Gets operation path.

Methods inherited from class org.springdoc.core.versions.SpringDocVersionStrategy

getVersion, getVersionDefaultMap, setVersion, updateQueryParams, updateVersion

Methods inherited from class java.lang.Object

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

Constructor Details

PathVersionStrategy

public PathVersionStrategy(int pathSegmentIndex,
 String defaultVersion)

Instantiates a new Path version strategy.

Parameters:

pathSegmentIndex - the path segment index

Method Details

getPathSegmentIndex

public int getPathSegmentIndex()

Gets path segment index.

Returns:

the path segment index

updateOperationPath

public String updateOperationPath(String operationPath,
 String version)

Description copied from class: SpringDocVersionStrategy

Gets operation path.

Overrides:

updateOperationPath in class SpringDocVersionStrategy

Parameters:

operationPath - the operation path

version - the version

Returns:

the operation path