org.springdoc.core

Class SwaggerUiConfigProperties

java.lang.Object

org.springdoc.core.SwaggerUiConfigProperties

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

Please refer to the swagger configuration.md to get the idea what each parameter does.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_URL_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SwaggerUiConfigProperties()

Method Summary

Modifier and Type	Method and Description
static void	addGroup(String group)
static void	addGroup(String group, String url)
static void	addUrl(String url)
Map<String,Object>	getConfigParameters()
String	getConfigUrl()
Boolean	getDeepLinking()
Integer	getDefaultModelExpandDepth()
String	getDefaultModelRendering()
Integer	getDefaultModelsExpandDepth()
Boolean	getDisplayOperationId()
Boolean	getDisplayRequestDuration()
String	getDocExpansion()
String	getFilter()
String	getLayout()
Integer	getMaxDisplayedTags()
String	getOauth2RedirectUrl()
String	getOperationsSorter()
String	getPath()
Boolean	getShowCommonExtensions()
Boolean	getShowExtensions()
List<String>	getSupportedSubmitMethods()
static List<org.springdoc.core.SwaggerUiConfigProperties.SwaggerUrl>	getSwaggerUrls()
String	getTagsSorter()
String	getUrl()
String	getValidatorUrl()
boolean	isValidUrl(String url)
protected void	put(String name, Boolean value, Map<String,Object> params)
protected void	put(String name, Integer value, Map<String,Object> params)
protected void	put(String urls, List<org.springdoc.core.SwaggerUiConfigProperties.SwaggerUrl> swaggerUrls, Map<String,Object> params)
protected void	put(String name, String value, Map<String,Object> params)
void	setConfigUrl(String configUrl)
void	setDeepLinking(Boolean deepLinking)
void	setDefaultModelExpandDepth(Integer defaultModelExpandDepth)
void	setDefaultModelRendering(String defaultModelRendering)
void	setDefaultModelsExpandDepth(Integer defaultModelsExpandDepth)
void	setDisplayOperationId(Boolean displayOperationId)
void	setDisplayRequestDuration(Boolean displayRequestDuration)
void	setDocExpansion(String docExpansion)
void	setFilter(String filter)
void	setLayout(String layout)
void	setMaxDisplayedTags(Integer maxDisplayedTags)
void	setOauth2RedirectUrl(String oauth2RedirectUrl)
void	setOperationsSorter(String operationsSorter)
void	setPath(String path)
void	setShowCommonExtensions(Boolean showCommonExtensions)
void	setShowExtensions(Boolean showExtensions)
void	setSupportedSubmitMethods(List<String> supportedSubmitMethods)
static void	setSwaggerUrls(List<org.springdoc.core.SwaggerUiConfigProperties.SwaggerUrl> swaggerUrls)
void	setTagsSorter(String tagsSorter)
void	setUrl(String url)
void	setValidatorUrl(String validatorUrl)

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

See Also:

Constant Field Values

Constructor Detail

SwaggerUiConfigProperties

public SwaggerUiConfigProperties()

Method Detail

addGroup

public static void addGroup(String group)

addGroup

public static void addGroup(String group,
                            String url)

getSwaggerUrls

public static List<org.springdoc.core.SwaggerUiConfigProperties.SwaggerUrl> getSwaggerUrls()

setSwaggerUrls

public static void setSwaggerUrls(List<org.springdoc.core.SwaggerUiConfigProperties.SwaggerUrl> swaggerUrls)

addUrl

public static void addUrl(String url)

getConfigParameters

public Map<String,Object> getConfigParameters()

put

protected void put(String urls,
                   List<org.springdoc.core.SwaggerUiConfigProperties.SwaggerUrl> swaggerUrls,
                   Map<String,Object> params)

put

protected void put(String name,
                   Integer value,
                   Map<String,Object> params)

put

protected void put(String name,
                   Boolean value,
                   Map<String,Object> params)

put

protected void put(String name,
                   String value,
                   Map<String,Object> params)

getValidatorUrl

public String getValidatorUrl()

setValidatorUrl

public void setValidatorUrl(String validatorUrl)

getPath

public String getPath()

setPath

public void setPath(String path)

getLayout

public String getLayout()

setLayout

public void setLayout(String layout)

getConfigUrl

public String getConfigUrl()

setConfigUrl

public void setConfigUrl(String configUrl)

getFilter

public String getFilter()

setFilter

public void setFilter(String filter)

getOperationsSorter

public String getOperationsSorter()

setOperationsSorter

public void setOperationsSorter(String operationsSorter)

getTagsSorter

public String getTagsSorter()

setTagsSorter

public void setTagsSorter(String tagsSorter)

getDeepLinking

public Boolean getDeepLinking()

setDeepLinking

public void setDeepLinking(Boolean deepLinking)

getDisplayOperationId

public Boolean getDisplayOperationId()

setDisplayOperationId

public void setDisplayOperationId(Boolean displayOperationId)

getDefaultModelsExpandDepth

public Integer getDefaultModelsExpandDepth()

setDefaultModelsExpandDepth

public void setDefaultModelsExpandDepth(Integer defaultModelsExpandDepth)

getDefaultModelExpandDepth

public Integer getDefaultModelExpandDepth()

setDefaultModelExpandDepth

public void setDefaultModelExpandDepth(Integer defaultModelExpandDepth)

getDefaultModelRendering

public String getDefaultModelRendering()

setDefaultModelRendering

public void setDefaultModelRendering(String defaultModelRendering)

getDisplayRequestDuration

public Boolean getDisplayRequestDuration()

setDisplayRequestDuration

public void setDisplayRequestDuration(Boolean displayRequestDuration)

getDocExpansion

public String getDocExpansion()

setDocExpansion

public void setDocExpansion(String docExpansion)

getMaxDisplayedTags

public Integer getMaxDisplayedTags()

setMaxDisplayedTags

public void setMaxDisplayedTags(Integer maxDisplayedTags)

getShowExtensions

public Boolean getShowExtensions()

setShowExtensions

public void setShowExtensions(Boolean showExtensions)

getShowCommonExtensions

public Boolean getShowCommonExtensions()

setShowCommonExtensions

public void setShowCommonExtensions(Boolean showCommonExtensions)

getSupportedSubmitMethods

public List<String> getSupportedSubmitMethods()

setSupportedSubmitMethods

public void setSupportedSubmitMethods(List<String> supportedSubmitMethods)

getOauth2RedirectUrl

public String getOauth2RedirectUrl()

setOauth2RedirectUrl

public void setOauth2RedirectUrl(String oauth2RedirectUrl)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

isValidUrl

public boolean isValidUrl(String url)