Package org.springdoc.core.versions

Class HeaderVersionStrategy

java.lang.Object

org.springdoc.core.versions.SpringDocVersionStrategy

org.springdoc.core.versions.HeaderVersionStrategy

public class HeaderVersionStrategy
extends SpringDocVersionStrategy

The type Header version strategy.

Author:

bnasslahsen

Field Summary

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

defaultVersion, version, versionDefaultMap

Constructor Summary

Constructors

Constructor	Description
HeaderVersionStrategy(String headerName, String defaultVersion)	Instantiates a new Header version strategy.

Method Summary

Modifier and Type	Method	Description
String	getHeaderName()	Gets header name.

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

getVersion, getVersionDefaultMap, setVersion, updateOperationPath, updateQueryParams, updateVersion

Methods inherited from class java.lang.Object

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

Constructor Details

HeaderVersionStrategy

public HeaderVersionStrategy(String headerName,
 String defaultVersion)

Instantiates a new Header version strategy.

Parameters:

headerName - the header name

Method Details

getHeaderName

public String getHeaderName()

Gets header name.

Returns:

the header name