org.springdoc.core

Class SpringDocConfigProperties

java.lang.Object

org.springdoc.core.SpringDocConfigProperties

@Configuration
 @ConfigurationProperties(prefix="springdoc")
 @ConditionalOnProperty(name="springdoc.api-docs.enabled",
                       matchIfMissing=true)
public class SpringDocConfigProperties
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpringDocConfigProperties.ApiDocs
static class	SpringDocConfigProperties.Cache
static class	SpringDocConfigProperties.GroupConfig
static class	SpringDocConfigProperties.Groups
static class	SpringDocConfigProperties.Webjars

Constructor Summary

Constructors

Constructor and Description
SpringDocConfigProperties()

Method Summary

Modifier and Type	Method and Description
void	addGroupConfig(SpringDocConfigProperties.GroupConfig groupConfigs)
SpringDocConfigProperties.ApiDocs	getApiDocs()
SpringDocConfigProperties.Cache	getCache()
String	getDefaultConsumesMediaType()
String	getDefaultProducesMediaType()
List<SpringDocConfigProperties.GroupConfig>	getGroupConfigs()
List<String>	getPackagesToExclude()
List<String>	getPackagesToScan()
List<String>	getPathsToExclude()
List<String>	getPathsToMatch()
SpringDocConfigProperties.Webjars	getWebjars()
boolean	isAutoTagClasses()
boolean	isCacheDisabled()
boolean	isModelAndViewAllowed()
boolean	isOverrideWithGenericResponse()
boolean	isRemoveBrokenReferenceDefinitions()
boolean	isShowActuator()
void	setApiDocs(SpringDocConfigProperties.ApiDocs apiDocs)
void	setAutoTagClasses(boolean autoTagClasses)
void	setCache(SpringDocConfigProperties.Cache cache)
void	setDefaultConsumesMediaType(String defaultConsumesMediaType)
void	setDefaultProducesMediaType(String defaultProducesMediaType)
void	setGroupConfigs(List<SpringDocConfigProperties.GroupConfig> groupConfigs)
void	setModelAndViewAllowed(boolean modelAndViewAllowed)
void	setOverrideWithGenericResponse(boolean overrideWithGenericResponse)
void	setPackagesToExclude(List<String> packagesToExclude)
void	setPackagesToScan(List<String> packagesToScan)
void	setPathsToExclude(List<String> pathsToExclude)
void	setPathsToMatch(List<String> pathsToMatch)
void	setRemoveBrokenReferenceDefinitions(boolean removeBrokenReferenceDefinitions)
void	setShowActuator(boolean showActuator)
void	setWebjars(SpringDocConfigProperties.Webjars webjars)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringDocConfigProperties

public SpringDocConfigProperties()

Method Detail

isAutoTagClasses

public boolean isAutoTagClasses()

setAutoTagClasses

public void setAutoTagClasses(boolean autoTagClasses)

isModelAndViewAllowed

public boolean isModelAndViewAllowed()

setModelAndViewAllowed

public void setModelAndViewAllowed(boolean modelAndViewAllowed)

getPackagesToExclude

public List<String> getPackagesToExclude()

setPackagesToExclude

public void setPackagesToExclude(List<String> packagesToExclude)

getPathsToExclude

public List<String> getPathsToExclude()

setPathsToExclude

public void setPathsToExclude(List<String> pathsToExclude)

getPackagesToScan

public List<String> getPackagesToScan()

setPackagesToScan

public void setPackagesToScan(List<String> packagesToScan)

isShowActuator

public boolean isShowActuator()

setShowActuator

public void setShowActuator(boolean showActuator)

getWebjars

public SpringDocConfigProperties.Webjars getWebjars()

setWebjars

public void setWebjars(SpringDocConfigProperties.Webjars webjars)

getApiDocs

public SpringDocConfigProperties.ApiDocs getApiDocs()

setApiDocs

public void setApiDocs(SpringDocConfigProperties.ApiDocs apiDocs)

getPathsToMatch

public List<String> getPathsToMatch()

setPathsToMatch

public void setPathsToMatch(List<String> pathsToMatch)

getCache

public SpringDocConfigProperties.Cache getCache()

setCache

public void setCache(SpringDocConfigProperties.Cache cache)

isCacheDisabled

public boolean isCacheDisabled()

getGroupConfigs

public List<SpringDocConfigProperties.GroupConfig> getGroupConfigs()

setGroupConfigs

public void setGroupConfigs(List<SpringDocConfigProperties.GroupConfig> groupConfigs)

addGroupConfig

public void addGroupConfig(SpringDocConfigProperties.GroupConfig groupConfigs)

getDefaultConsumesMediaType

public String getDefaultConsumesMediaType()

setDefaultConsumesMediaType

public void setDefaultConsumesMediaType(String defaultConsumesMediaType)

getDefaultProducesMediaType

public String getDefaultProducesMediaType()

setDefaultProducesMediaType

public void setDefaultProducesMediaType(String defaultProducesMediaType)

isOverrideWithGenericResponse

public boolean isOverrideWithGenericResponse()

setOverrideWithGenericResponse

public void setOverrideWithGenericResponse(boolean overrideWithGenericResponse)

isRemoveBrokenReferenceDefinitions

public boolean isRemoveBrokenReferenceDefinitions()

setRemoveBrokenReferenceDefinitions

public void setRemoveBrokenReferenceDefinitions(boolean removeBrokenReferenceDefinitions)