Package de.hybris.platform.webservicescommons.swagger.strategies.impl

Class DefaultApiVendorExtensionStrategy

java.lang.Object

de.hybris.platform.webservicescommons.swagger.strategies.ConfigApiVendorExtensionStrategy

de.hybris.platform.webservicescommons.swagger.strategies.impl.DefaultApiVendorExtensionStrategy

All Implemented Interfaces:

ApiVendorExtensionStrategy

public class DefaultApiVendorExtensionStrategy
extends ConfigApiVendorExtensionStrategy

Default implementation of ApiVendorExtensionStrategy.

It provides vendor extensions describing API. The result list includes: "x-sap-api-type", "x-sap-shortText" and "x-sap-stateInfo" extensions.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONFIG_API_TYPE
protected static final String	CONFIG_SHORT_TEXT
protected static final String	CONFIG_STATE
protected static final String	EXT_API_TYPE
protected static final String	EXT_SHORT_TEXT
protected static final String	EXT_STATE
protected static final String	EXT_STATE_INFO

Fields inherited from class de.hybris.platform.webservicescommons.swagger.strategies.ConfigApiVendorExtensionStrategy

CONFIG_ARRAY_DELIMITER, CONFIG_DELIMITER

Constructor Summary

Constructors

Constructor	Description
DefaultApiVendorExtensionStrategy()

Method Summary

Modifier and Type	Method	Description
protected String	getApiType(String configPrefix)
protected String	getShortText(String configPrefix)
protected String	getState(String configPrefix)
List<springfox.documentation.service.VendorExtension>	getVendorExtensions(String configPrefix)	Provides a list of vendor extensions for the API based on the configuration prefix.

Methods inherited from class de.hybris.platform.webservicescommons.swagger.strategies.ConfigApiVendorExtensionStrategy

getConfigArray, getConfigKey, getConfigValue, setConfigurationService

Methods inherited from class java.lang.Object

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

Field Details

EXT_API_TYPE

protected static final String EXT_API_TYPE

See Also:

• Constant Field Values

EXT_SHORT_TEXT

protected static final String EXT_SHORT_TEXT

See Also:

• Constant Field Values

EXT_STATE_INFO

protected static final String EXT_STATE_INFO

See Also:

• Constant Field Values

EXT_STATE

protected static final String EXT_STATE

See Also:

• Constant Field Values

CONFIG_API_TYPE

protected static final String CONFIG_API_TYPE

See Also:

• Constant Field Values

CONFIG_SHORT_TEXT

protected static final String CONFIG_SHORT_TEXT

See Also:

• Constant Field Values

CONFIG_STATE

protected static final String CONFIG_STATE

See Also:

• Constant Field Values

Constructor Details

DefaultApiVendorExtensionStrategy

public DefaultApiVendorExtensionStrategy()

Method Details

getVendorExtensions

public List<springfox.documentation.service.VendorExtension> getVendorExtensions(String configPrefix)

Description copied from interface: ApiVendorExtensionStrategy

Provides a list of vendor extensions for the API based on the configuration prefix.

Parameters:

configPrefix - configuration prefix

Returns:

list of vendor extension

getApiType

protected String getApiType(String configPrefix)

getShortText

protected String getShortText(String configPrefix)

getState

protected String getState(String configPrefix)