Package org.springdoc.core.properties

Class SwaggerUiConfigParameters

java.lang.Object

org.springdoc.core.properties.AbstractSwaggerUiConfigProperties

org.springdoc.core.properties.SwaggerUiConfigParameters

public class SwaggerUiConfigParameters
extends AbstractSwaggerUiConfigProperties

The type Swagger ui config parameters.

Author:

bnasslahsen

Nested Class Summary

Nested classes/interfaces inherited from class org.springdoc.core.properties.AbstractSwaggerUiConfigProperties

AbstractSwaggerUiConfigProperties.SwaggerUrl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_URL_PROPERTY	The constant CONFIG_URL_PROPERTY.
static final String	DEEP_LINKING_PROPERTY	The constant DEEP_LINKING.
static final String	DISPLAY_OPERATION_ID_PROPERTY	The constant DISPLAY_OPERATION_ID.
static final String	DISPLAY_REQUEST_DURATION_PROPERTY	The constant DISPLAY_REQUEST_DURATION.
static final String	FILTER_PROPERTY	The constant FILTER_PROPERTY.
static final String	LAYOUT_PROPERTY	The constant LAYOUT_PROPERTY.
static final String	OAUTH2_REDIRECT_URL_PROPERTY	The constant OAUTH2_REDIRECT_URL_PROPERTY.
static final String	PERSIST_AUTHORIZATION_PROPERTY	The constant PERSIST_AUTHORIZATION_PROPERTY.
static final String	QUERY_CONFIG_ENABLED_PROPERTY	The constant QUERY_CONFIG_ENABLED_PROPERTY.
static final String	SHOW_COMMON_EXTENSIONS_PROPERTY	The constant SHOW_COMMON_EXTENSIONS_PROPERTY.
static final String	SHOW_EXTENSIONS_PROPERTY	The constant SHOW_EXTENSIONS_PROPERTY.
static final String	TRY_IT_ENABLED_PROPERTY	The constant TRY_IT_ENABLED_PROPERTY.
static final String	URL_PROPERTY	The constant URL_PROPERTY.
static final String	URLS_PROPERTY	The constant URLS_PROPERTY.
static final String	VALIDATOR_URL_PROPERTY	The constant VALIDATOR_URL_PROPERTY.
static final String	WITH_CREDENTIALS_PROPERTY	The constant WITH_CREDENTIALS_PROPERTY.

Fields inherited from class org.springdoc.core.properties.AbstractSwaggerUiConfigProperties

configUrl, deepLinking, defaultModelExpandDepth, defaultModelRendering, defaultModelsExpandDepth, displayOperationId, displayRequestDuration, docExpansion, filter, groupsOrder, layout, maxDisplayedTags, oauth2RedirectUrl, operationsSorter, path, persistAuthorization, queryConfigEnabled, showCommonExtensions, showExtensions, supportedSubmitMethods, tagsSorter, tryItOutEnabled, url, urls, urlsPrimaryName, validatorUrl, withCredentials

Constructor Summary

Constructors

Constructor	Description
SwaggerUiConfigParameters(SwaggerUiConfigProperties swaggerUiConfig)	Instantiates a new Swagger ui config parameters.

Method Summary

Modifier and Type	Method	Description
void	addGroup(String group)	Add group.
void	addGroup(String group, String displayName)	Add group.
void	addUrl(String url)	Add url.
String	getApiDocsUrl()	Gets api docs url.
Map<String,Object>	getConfigParameters()	Gets config parameters.
String	getContextPath()	Gets context path.
String	getPathPrefix()	Gets path prefix.
String	getUiRootPath()	Gets ui root path.
boolean	isValidUrl(String url)	Is valid url boolean.
void	setApiDocsUrl(String apiDocsUrl)	Sets api docs url.
void	setContextPath(String contextPath)	Sets context path.
void	setPathPrefix(String pathPrefix)	Sets path prefix.
void	setUiRootPath(String uiRootPath)	Sets ui root path.

Methods inherited from class org.springdoc.core.properties.AbstractSwaggerUiConfigProperties

getConfigUrl, getDeepLinking, getDefaultModelExpandDepth, getDefaultModelRendering, getDefaultModelsExpandDepth, getDisplayOperationId, getDisplayRequestDuration, getDocExpansion, getFilter, getGroupsOrder, getLayout, getMaxDisplayedTags, getOauth2RedirectUrl, getOperationsSorter, getPath, getPersistAuthorization, getQueryConfigEnabled, getShowCommonExtensions, getShowExtensions, getSupportedSubmitMethods, getTagsSorter, getTryItOutEnabled, getUrl, getUrls, getUrlsPrimaryName, getValidatorUrl, getWithCredentials, setConfigUrl, setDeepLinking, setDefaultModelExpandDepth, setDefaultModelRendering, setDefaultModelsExpandDepth, setDisplayOperationId, setDisplayRequestDuration, setDocExpansion, setFilter, setGroupsOrder, setLayout, setMaxDisplayedTags, setOauth2RedirectUrl, setOperationsSorter, setPath, setPersistAuthorization, setQueryConfigEnabled, setShowCommonExtensions, setShowExtensions, setSupportedSubmitMethods, setTagsSorter, setTryItOutEnabled, setUrl, setUrls, setUrlsPrimaryName, setValidatorUrl, setWithCredentials

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_URL_PROPERTY

public static final String CONFIG_URL_PROPERTY

The constant CONFIG_URL_PROPERTY.

See Also:

• Constant Field Values

LAYOUT_PROPERTY

public static final String LAYOUT_PROPERTY

The constant LAYOUT_PROPERTY.

See Also:

• Constant Field Values

FILTER_PROPERTY

public static final String FILTER_PROPERTY

The constant FILTER_PROPERTY.

See Also:

• Constant Field Values

URL_PROPERTY

public static final String URL_PROPERTY

The constant URL_PROPERTY.

See Also:

• Constant Field Values

URLS_PROPERTY

public static final String URLS_PROPERTY

The constant URLS_PROPERTY.

See Also:

• Constant Field Values

OAUTH2_REDIRECT_URL_PROPERTY

public static final String OAUTH2_REDIRECT_URL_PROPERTY

The constant OAUTH2_REDIRECT_URL_PROPERTY.

See Also:

• Constant Field Values

VALIDATOR_URL_PROPERTY

public static final String VALIDATOR_URL_PROPERTY

The constant VALIDATOR_URL_PROPERTY.

See Also:

• Constant Field Values

QUERY_CONFIG_ENABLED_PROPERTY

public static final String QUERY_CONFIG_ENABLED_PROPERTY

The constant QUERY_CONFIG_ENABLED_PROPERTY.

See Also:

• Constant Field Values

DISPLAY_OPERATION_ID_PROPERTY

public static final String DISPLAY_OPERATION_ID_PROPERTY

The constant DISPLAY_OPERATION_ID.

See Also:

• Constant Field Values

DEEP_LINKING_PROPERTY

public static final String DEEP_LINKING_PROPERTY

The constant DEEP_LINKING.

See Also:

• Constant Field Values

DISPLAY_REQUEST_DURATION_PROPERTY

public static final String DISPLAY_REQUEST_DURATION_PROPERTY

The constant DISPLAY_REQUEST_DURATION.

See Also:

• Constant Field Values

SHOW_EXTENSIONS_PROPERTY

public static final String SHOW_EXTENSIONS_PROPERTY

The constant SHOW_EXTENSIONS_PROPERTY.

See Also:

• Constant Field Values

SHOW_COMMON_EXTENSIONS_PROPERTY

public static final String SHOW_COMMON_EXTENSIONS_PROPERTY

The constant SHOW_COMMON_EXTENSIONS_PROPERTY.

See Also:

• Constant Field Values

TRY_IT_ENABLED_PROPERTY

public static final String TRY_IT_ENABLED_PROPERTY

The constant TRY_IT_ENABLED_PROPERTY.

See Also:

• Constant Field Values

PERSIST_AUTHORIZATION_PROPERTY

public static final String PERSIST_AUTHORIZATION_PROPERTY

The constant PERSIST_AUTHORIZATION_PROPERTY.

See Also:

• Constant Field Values

WITH_CREDENTIALS_PROPERTY

public static final String WITH_CREDENTIALS_PROPERTY

The constant WITH_CREDENTIALS_PROPERTY.

See Also:

• Constant Field Values

Constructor Details

SwaggerUiConfigParameters

public SwaggerUiConfigParameters(SwaggerUiConfigProperties swaggerUiConfig)

Instantiates a new Swagger ui config parameters.

Parameters:

swaggerUiConfig - the swagger ui config

Method Details

addGroup

public void addGroup(String group,
 String displayName)

Add group.

Parameters:

group - the group

displayName - the display name

addGroup

public void addGroup(String group)

Add group.

Parameters:

group - the group

addUrl

public void addUrl(String url)

Add url.

Parameters:

url - the url

getUiRootPath

public String getUiRootPath()

Gets ui root path.

Returns:

the ui root path

setUiRootPath

public void setUiRootPath(String uiRootPath)

Sets ui root path.

Parameters:

uiRootPath - the ui root path

isValidUrl

public boolean isValidUrl(String url)

Is valid url boolean.

Parameters:

url - the url

Returns:

the boolean

getConfigParameters

public Map<String,Object> getConfigParameters()

Gets config parameters.

Returns:

the config parameters

getContextPath

public String getContextPath()

Gets context path.

Returns:

the context path

setContextPath

public void setContextPath(String contextPath)

Sets context path.

Parameters:

contextPath - the context path

getApiDocsUrl

public String getApiDocsUrl()

Gets api docs url.

Returns:

the api docs url

setApiDocsUrl

public void setApiDocsUrl(String apiDocsUrl)

Sets api docs url.

Parameters:

apiDocsUrl - the api docs url

getPathPrefix

public String getPathPrefix()

Gets path prefix.

Returns:

the path prefix

setPathPrefix

public void setPathPrefix(String pathPrefix)

Sets path prefix.

Parameters:

pathPrefix - the path prefix