Package org.springdoc.core

Class SwaggerUiConfigProperties

java.lang.Object

org.springdoc.core.AbstractSwaggerUiConfigProperties

org.springdoc.core.SwaggerUiConfigProperties

@Lazy(false)
@Configuration(proxyBeanMethods=false)
@ConfigurationProperties(prefix="springdoc.swagger-ui")
@ConditionalOnProperty(name="springdoc.swagger-ui.enabled",
                       matchIfMissing=true)
@ConditionalOnBean(SpringDocConfiguration.class)
public class SwaggerUiConfigProperties
extends AbstractSwaggerUiConfigProperties

The type Swagger ui config properties.

Author:

bnasslahsen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SwaggerUiConfigProperties.Csrf	The type Csrf.
static class	SwaggerUiConfigProperties.SyntaxHighlight	The type Syntax highlight.

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

AbstractSwaggerUiConfigProperties.SwaggerUrl

Field Summary

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
SwaggerUiConfigProperties()

Method Summary

Modifier and Type	Method	Description
SwaggerUiConfigProperties.Csrf	getCsrf()	Gets csrf.
boolean	isCsrfEnabled()	Is csrf enabled boolean.
boolean	isDisableSwaggerDefaultUrl()	Is disable swagger default url boolean.
boolean	isDisplayQueryParams()	Is display query params boolean.
boolean	isDisplayQueryParamsWithoutOauth2()	Is display query params without oauth 2 boolean.
boolean	isEnabled()	Is enabled boolean.
boolean	isUseRootPath()	Is use root path boolean.
void	setCsrf(SwaggerUiConfigProperties.Csrf csrf)	Sets csrf.
void	setDisableSwaggerDefaultUrl(boolean disableSwaggerDefaultUrl)	Sets disable swagger default url.
void	setDisplayQueryParams(boolean displayQueryParams)	Sets display query params.
void	setDisplayQueryParamsWithoutOauth2(boolean displayQueryParamsWithoutOauth2)	Sets display query params without oauth 2.
void	setEnabled(boolean enabled)	Sets enabled.
void	setUseRootPath(boolean useRootPath)	Sets use 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

Constructor Detail

SwaggerUiConfigProperties

public SwaggerUiConfigProperties()

Method Detail

isUseRootPath

public boolean isUseRootPath()

Is use root path boolean.

Returns:

the boolean

setUseRootPath

public void setUseRootPath(boolean useRootPath)

Sets use root path.

Parameters:

useRootPath - the use root path

isEnabled

public boolean isEnabled()

Is enabled boolean.

Returns:

the boolean

setEnabled

public void setEnabled(boolean enabled)

Sets enabled.

Parameters:

enabled - the enabled

isDisableSwaggerDefaultUrl

public boolean isDisableSwaggerDefaultUrl()

Is disable swagger default url boolean.

Returns:

the boolean

setDisableSwaggerDefaultUrl

public void setDisableSwaggerDefaultUrl(boolean disableSwaggerDefaultUrl)

Sets disable swagger default url.

Parameters:

disableSwaggerDefaultUrl - the disable swagger default url

isDisplayQueryParams

public boolean isDisplayQueryParams()

Is display query params boolean.

Returns:

the boolean

setDisplayQueryParams

public void setDisplayQueryParams(boolean displayQueryParams)

Sets display query params.

Parameters:

displayQueryParams - the display query params

isDisplayQueryParamsWithoutOauth2

public boolean isDisplayQueryParamsWithoutOauth2()

Is display query params without oauth 2 boolean.

Returns:

the boolean

setDisplayQueryParamsWithoutOauth2

public void setDisplayQueryParamsWithoutOauth2(boolean displayQueryParamsWithoutOauth2)

Sets display query params without oauth 2.

Parameters:

displayQueryParamsWithoutOauth2 - the display query params without oauth 2

getCsrf

public SwaggerUiConfigProperties.Csrf getCsrf()

Gets csrf.

Returns:

the csrf

setCsrf

public void setCsrf(SwaggerUiConfigProperties.Csrf csrf)

Sets csrf.

Parameters:

csrf - the csrf

isCsrfEnabled

public boolean isCsrfEnabled()

Is csrf enabled boolean.

Returns:

the boolean