Package org.springdoc.core

Class SwaggerUiConfigParameters

java.lang.Object

org.springdoc.core.AbstractSwaggerUiConfigProperties

org.springdoc.core.SwaggerUiConfigParameters

@Lazy(false)
@Configuration(proxyBeanMethods=false)
@ConditionalOnProperty(name="springdoc.swagger-ui.enabled",
                       matchIfMissing=true)
@ConditionalOnBean(SpringDocConfiguration.class)
@PropertySource("classpath:springdoc.swagger-ui.config")
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.AbstractSwaggerUiConfigProperties

AbstractSwaggerUiConfigProperties.SwaggerUrl

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_URL_PROPERTY	The constant CONFIG_URL_PROPERTY.
static String	FILTER_PROPERTY	The constant FILTER_PROPERTY.
static String	LAYOUT_PROPERTY	The constant LAYOUT_PROPERTY.
static String	OAUTH2_REDIRECT_URL_PROPERTY	The constant OAUTH2_REDIRECT_URL_PROPERTY.
static String	URLS_PROPERTY	The constant URLS_PROPERTY.

Fields inherited from class org.springdoc.core.AbstractSwaggerUiConfigProperties

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

Constructor Summary

Constructors

Constructor	Description
SwaggerUiConfigParameters(SwaggerUiConfigProperties swaggerUiConfig, Optional<SpringDocHints> springDocHintsOptional)	Instantiates a new Swagger ui config parameters.

Method Summary

Modifier and Type	Method	Description
void	addGroup(String group)	Add group.
void	addUrl(String url)	Add url.
Map<String,Object>	getConfigParameters()	Gets config parameters.
Optional<SpringDocHints>	getSpringDocHintsOptional()	Gets spring doc hints optional.
String	getSwaggerUiVersion()	Gets swagger ui version.
String	getUiRootPath()	Gets ui root path.
boolean	isValidUrl(String url)	Is valid url boolean.
void	setSwaggerUiVersion(String swaggerUiVersion)	Sets swagger ui version.
void	setUiRootPath(String uiRootPath)	Sets ui root path.

Methods inherited from class org.springdoc.core.AbstractSwaggerUiConfigProperties

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

Methods inherited from class java.lang.Object

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

Field Detail

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

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

Constructor Detail

SwaggerUiConfigParameters

public SwaggerUiConfigParameters(SwaggerUiConfigProperties swaggerUiConfig,
                                 Optional<SpringDocHints> springDocHintsOptional)

Instantiates a new Swagger ui config parameters.

Parameters:

swaggerUiConfig - the swagger ui config

springDocHintsOptional - the spring doc hints optional

Method Detail

getSpringDocHintsOptional

public Optional<SpringDocHints> getSpringDocHintsOptional()

Gets spring doc hints optional.

Returns:

the spring doc hints optional

getSwaggerUiVersion

public String getSwaggerUiVersion()

Gets swagger ui version.

Returns:

the swagger ui version

setSwaggerUiVersion

public void setSwaggerUiVersion(String swaggerUiVersion)

Sets swagger ui version.

Parameters:

swaggerUiVersion - the swagger ui version

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