org.springdoc.core

Class SpringDocConfigProperties

java.lang.Object

org.springdoc.core.SpringDocConfigProperties

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

The type Spring doc config properties.

Author:

bnasslahsen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpringDocConfigProperties.ApiDocs The type Api docs.
static class	SpringDocConfigProperties.Cache The type Cache.
static class	SpringDocConfigProperties.GroupConfig The type Group config.
static class	SpringDocConfigProperties.Groups The type Groups.
static class	SpringDocConfigProperties.ModelConverters The type Model converters.
static class	SpringDocConfigProperties.SortConverter The type Sort converter.
static class	SpringDocConfigProperties.Webjars The type Webjars.

Constructor Summary

Constructors

Constructor and Description
SpringDocConfigProperties()

Method Summary

Modifier and Type	Method and Description
void	addGroupConfig(SpringDocConfigProperties.GroupConfig groupConfigs) Add group config.
SpringDocConfigProperties.ApiDocs	getApiDocs() Gets api docs.
SpringDocConfigProperties.Cache	getCache() Gets cache.
List<String>	getConsumesToMatch() Gets consumes to match.
String	getDefaultConsumesMediaType() Gets default consumes media type.
String	getDefaultProducesMediaType() Gets default produces media type.
Set<SpringDocConfigProperties.GroupConfig>	getGroupConfigs() Gets group configs.
List<String>	getHeadersToMatch() Gets headers to match.
SpringDocConfigProperties.ModelConverters	getModelConverters() Gets model converters.
Boolean	getOverrideWithGenericResponse() Gets override with generic response.
List<String>	getPackagesToExclude() Gets packages to exclude.
List<String>	getPackagesToScan() Gets packages to scan.
List<String>	getPathsToExclude() Gets paths to exclude.
List<String>	getPathsToMatch() Gets paths to match.
List<String>	getPreLoadingLocales() locale list to pre-loading.
List<String>	getProducesToMatch() Gets produces to match.
SpringDocConfigProperties.SortConverter	getSortConverter() Gets sort converter.
io.swagger.v3.oas.models.SpecVersion	getSpecVersion() Gets spec version.
SpringDocConfigProperties.Webjars	getWebjars() Gets webjars.
boolean	isAutoTagClasses() Is auto tag classes boolean.
boolean	isCacheDisabled() Is cache disabled boolean.
boolean	isDefaultFlatParamObject() Is default flat param object boolean.
boolean	isDefaultOverrideWithGenericResponse() Gets default override with generic response.
boolean	isDefaultSupportFormData() Is default support form data boolean.
boolean	isDisableI18n() Is disable i 18 n boolean.
boolean	isEnableDataRest() Is enable data rest boolean.
boolean	isEnableGroovy() Is enable groovy boolean.
boolean	isEnableHateoas() Is enable hateoas boolean.
boolean	isEnableJavadoc() Is enable javadoc boolean.
boolean	isEnableKotlin() Is enable kotlin boolean.
boolean	isEnableSpringSecurity() Is enable spring security boolean.
boolean	isModelAndViewAllowed() Is model and view allowed boolean.
boolean	isNullableRequestParameterEnabled() Is nullable request parameter enabled boolean.
boolean	isOpenapi31() Is openapi 31 boolean.
boolean	isOverrideWithGenericResponse() Is override with generic response boolean.
boolean	isPreLoadingEnabled() Is pre loading enabled boolean.
boolean	isRemoveBrokenReferenceDefinitions() Is remove broken reference definitions boolean.
boolean	isShowActuator() Is show actuator boolean.
boolean	isShowLoginEndpoint() Is show login endpoint boolean.
boolean	isShowOauth2Endpoints() Is show oauth 2 endpoints boolean.
boolean	isShowSpringCloudFunctions() Is show spring cloud functions boolean.
boolean	isUseFqn() Is use fqn boolean.
boolean	isUseManagementPort() Is use management port boolean.
boolean	isWriterWithDefaultPrettyPrinter() Is writer with default pretty printer boolean.
boolean	isWriterWithOrderByKeys() Is writer wither order by keys boolean.
void	setApiDocs(SpringDocConfigProperties.ApiDocs apiDocs) Sets api docs.
void	setAutoTagClasses(boolean autoTagClasses) Sets auto tag classes.
void	setCache(SpringDocConfigProperties.Cache cache) Sets cache.
void	setConsumesToMatch(List<String> consumesToMatch) Sets consumes to match.
void	setDefaultConsumesMediaType(String defaultConsumesMediaType) Sets default consumes media type.
void	setDefaultFlatParamObject(boolean defaultFlatParamObject) Sets default flat param object.
void	setDefaultProducesMediaType(String defaultProducesMediaType) Sets default produces media type.
void	setDefaultSupportFormData(boolean defaultSupportFormData) Sets default support form data.
void	setDisableI18n(boolean disableI18n) Sets disable i 18 n.
void	setEnableDataRest(boolean enableDataRest) Sets enable data rest.
void	setEnableGroovy(boolean enableGroovy) Sets enable groovy.
void	setEnableHateoas(boolean enableHateoas) Sets enable hateoas.
void	setEnableJavadoc(boolean enableJavadoc) Sets enable javadoc.
void	setEnableKotlin(boolean enableKotlin) Sets enable kotlin.
void	setEnableSpringSecurity(boolean enableSpringSecurity) Sets enable spring security.
void	setGroupConfigs(Set<SpringDocConfigProperties.GroupConfig> groupConfigs) Sets group configs.
void	setHeadersToMatch(List<String> headersToMatch) Sets headers to match.
void	setModelAndViewAllowed(boolean modelAndViewAllowed) Sets model and view allowed.
void	setModelConverters(SpringDocConfigProperties.ModelConverters modelConverters) Sets model converters.
void	setNullableRequestParameterEnabled(boolean nullableRequestParameterEnabled) Sets nullable request parameter enabled.
void	setOverrideWithGenericResponse(boolean overrideWithGenericResponse) Sets override with generic response.
void	setOverrideWithGenericResponse(Boolean overrideWithGenericResponse) Sets override with generic response.
void	setPackagesToExclude(List<String> packagesToExclude) Sets packages to exclude.
void	setPackagesToScan(List<String> packagesToScan) Sets packages to scan.
void	setPathsToExclude(List<String> pathsToExclude) Sets paths to exclude.
void	setPathsToMatch(List<String> pathsToMatch) Sets paths to match.
void	setPreLoadingEnabled(boolean preLoadingEnabled) Sets locale list to pre-loading.
void	setPreLoadingLocales(List<String> preLoadingLocales) Sets pre loading locales.
void	setProducesToMatch(List<String> producesToMatch) Sets produces to match.
void	setRemoveBrokenReferenceDefinitions(boolean removeBrokenReferenceDefinitions) Sets remove broken reference definitions.
void	setShowActuator(boolean showActuator) Sets show actuator.
void	setShowLoginEndpoint(boolean showLoginEndpoint) Sets show login endpoint.
void	setShowOauth2Endpoints(boolean showOauth2Endpoints) Sets show oauth 2 endpoints.
void	setShowSpringCloudFunctions(boolean showSpringCloudFunctions) Sets show spring cloud functions.
void	setSortConverter(SpringDocConfigProperties.SortConverter sortConverter) Sets sort converter.
void	setUseFqn(boolean useFqn) Sets use fqn.
void	setUseManagementPort(boolean useManagementPort) Sets use management port.
void	setWebjars(SpringDocConfigProperties.Webjars webjars) Sets webjars.
void	setWriterWithDefaultPrettyPrinter(boolean writerWithDefaultPrettyPrinter) Sets writer with default pretty printer.
void	setWriterWithOrderByKeys(boolean writerWithOrderByKeys) Sets writer wither order by keys.

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

getOverrideWithGenericResponse

public Boolean getOverrideWithGenericResponse()

Gets override with generic response.

Returns:

the override with generic response

setOverrideWithGenericResponse

public void setOverrideWithGenericResponse(Boolean overrideWithGenericResponse)

Sets override with generic response.

Parameters:

overrideWithGenericResponse - the override with generic response

isNullableRequestParameterEnabled

public boolean isNullableRequestParameterEnabled()

Is nullable request parameter enabled boolean.

Returns:

the boolean

setNullableRequestParameterEnabled

public void setNullableRequestParameterEnabled(boolean nullableRequestParameterEnabled)

Sets nullable request parameter enabled.

Parameters:

nullableRequestParameterEnabled - the nullable request parameter enabled

isDefaultSupportFormData

public boolean isDefaultSupportFormData()

Is default support form data boolean.

Returns:

the boolean

setDefaultSupportFormData

public void setDefaultSupportFormData(boolean defaultSupportFormData)

Sets default support form data.

Parameters:

defaultSupportFormData - the default support form data

isDefaultFlatParamObject

public boolean isDefaultFlatParamObject()

Is default flat param object boolean.

Returns:

the boolean

setDefaultFlatParamObject

public void setDefaultFlatParamObject(boolean defaultFlatParamObject)

Sets default flat param object.

Parameters:

defaultFlatParamObject - the default flat param object

getSortConverter

public SpringDocConfigProperties.SortConverter getSortConverter()

Gets sort converter.

Returns:

the sort converter

setSortConverter

public void setSortConverter(SpringDocConfigProperties.SortConverter sortConverter)

Sets sort converter.

Parameters:

sortConverter - the sort converter

isEnableDataRest

public boolean isEnableDataRest()

Is enable data rest boolean.

Returns:

the boolean

setEnableDataRest

public void setEnableDataRest(boolean enableDataRest)

Sets enable data rest.

Parameters:

enableDataRest - the enable data rest

isEnableHateoas

public boolean isEnableHateoas()

Is enable hateoas boolean.

Returns:

the boolean

setEnableHateoas

public void setEnableHateoas(boolean enableHateoas)

Sets enable hateoas.

Parameters:

enableHateoas - the enable hateoas

isEnableKotlin

public boolean isEnableKotlin()

Is enable kotlin boolean.

Returns:

the boolean

setEnableKotlin

public void setEnableKotlin(boolean enableKotlin)

Sets enable kotlin.

Parameters:

enableKotlin - the enable kotlin

isEnableSpringSecurity

public boolean isEnableSpringSecurity()

Is enable spring security boolean.

Returns:

the boolean

setEnableSpringSecurity

public void setEnableSpringSecurity(boolean enableSpringSecurity)

Sets enable spring security.

Parameters:

enableSpringSecurity - the enable spring security

isEnableJavadoc

public boolean isEnableJavadoc()

Is enable javadoc boolean.

Returns:

the boolean

setEnableJavadoc

public void setEnableJavadoc(boolean enableJavadoc)

Sets enable javadoc.

Parameters:

enableJavadoc - the enable javadoc

isEnableGroovy

public boolean isEnableGroovy()

Is enable groovy boolean.

Returns:

the boolean

setEnableGroovy

public void setEnableGroovy(boolean enableGroovy)

Sets enable groovy.

Parameters:

enableGroovy - the enable groovy

isShowSpringCloudFunctions

public boolean isShowSpringCloudFunctions()

Is show spring cloud functions boolean.

Returns:

the boolean

setShowSpringCloudFunctions

public void setShowSpringCloudFunctions(boolean showSpringCloudFunctions)

Sets show spring cloud functions.

Parameters:

showSpringCloudFunctions - the show spring cloud functions

getModelConverters

public SpringDocConfigProperties.ModelConverters getModelConverters()

Gets model converters.

Returns:

the model converters

setModelConverters

public void setModelConverters(SpringDocConfigProperties.ModelConverters modelConverters)

Sets model converters.

Parameters:

modelConverters - the model converters

isUseManagementPort

public boolean isUseManagementPort()

Is use management port boolean.

Returns:

the boolean

setUseManagementPort

public void setUseManagementPort(boolean useManagementPort)

Sets use management port.

Parameters:

useManagementPort - the use management port

getProducesToMatch

public List<String> getProducesToMatch()

Gets produces to match.

Returns:

the produces to match

setProducesToMatch

public void setProducesToMatch(List<String> producesToMatch)

Sets produces to match.

Parameters:

producesToMatch - the produces to match

getHeadersToMatch

public List<String> getHeadersToMatch()

Gets headers to match.

Returns:

the headers to match

setHeadersToMatch

public void setHeadersToMatch(List<String> headersToMatch)

Sets headers to match.

Parameters:

headersToMatch - the headers to match

getConsumesToMatch

public List<String> getConsumesToMatch()

Gets consumes to match.

Returns:

the consumes to match

setConsumesToMatch

public void setConsumesToMatch(List<String> consumesToMatch)

Sets consumes to match.

Parameters:

consumesToMatch - the consumes to match

isUseFqn

public boolean isUseFqn()

Is use fqn boolean.

Returns:

the boolean

setUseFqn

public void setUseFqn(boolean useFqn)

Sets use fqn.

Parameters:

useFqn - the use fqn

isAutoTagClasses

public boolean isAutoTagClasses()

Is auto tag classes boolean.

Returns:

the boolean

setAutoTagClasses

public void setAutoTagClasses(boolean autoTagClasses)

Sets auto tag classes.

Parameters:

autoTagClasses - the auto tag classes

isModelAndViewAllowed

public boolean isModelAndViewAllowed()

Is model and view allowed boolean.

Returns:

the boolean

setModelAndViewAllowed

public void setModelAndViewAllowed(boolean modelAndViewAllowed)

Sets model and view allowed.

Parameters:

modelAndViewAllowed - the model and view allowed

getPackagesToExclude

public List<String> getPackagesToExclude()

Gets packages to exclude.

Returns:

the packages to exclude

setPackagesToExclude

public void setPackagesToExclude(List<String> packagesToExclude)

Sets packages to exclude.

Parameters:

packagesToExclude - the packages to exclude

getPathsToExclude

public List<String> getPathsToExclude()

Gets paths to exclude.

Returns:

the paths to exclude

setPathsToExclude

public void setPathsToExclude(List<String> pathsToExclude)

Sets paths to exclude.

Parameters:

pathsToExclude - the paths to exclude

isShowLoginEndpoint

public boolean isShowLoginEndpoint()

Is show login endpoint boolean.

Returns:

the boolean

setShowLoginEndpoint

public void setShowLoginEndpoint(boolean showLoginEndpoint)

Sets show login endpoint.

Parameters:

showLoginEndpoint - the show login endpoint

getPackagesToScan

public List<String> getPackagesToScan()

Gets packages to scan.

Returns:

the packages to scan

setPackagesToScan

public void setPackagesToScan(List<String> packagesToScan)

Sets packages to scan.

Parameters:

packagesToScan - the packages to scan

isShowActuator

public boolean isShowActuator()

Is show actuator boolean.

Returns:

the boolean

setShowActuator

public void setShowActuator(boolean showActuator)

Sets show actuator.

Parameters:

showActuator - the show actuator

getWebjars

public SpringDocConfigProperties.Webjars getWebjars()

Gets webjars.

Returns:

the webjars

setWebjars

public void setWebjars(SpringDocConfigProperties.Webjars webjars)

Sets webjars.

Parameters:

webjars - the webjars

getApiDocs

public SpringDocConfigProperties.ApiDocs getApiDocs()

Gets api docs.

Returns:

the api docs

setApiDocs

public void setApiDocs(SpringDocConfigProperties.ApiDocs apiDocs)

Sets api docs.

Parameters:

apiDocs - the api docs

getPathsToMatch

public List<String> getPathsToMatch()

Gets paths to match.

Returns:

the paths to match

setPathsToMatch

public void setPathsToMatch(List<String> pathsToMatch)

Sets paths to match.

Parameters:

pathsToMatch - the paths to match

getCache

public SpringDocConfigProperties.Cache getCache()

Gets cache.

Returns:

the cache

setCache

public void setCache(SpringDocConfigProperties.Cache cache)

Sets cache.

Parameters:

cache - the cache

isCacheDisabled

public boolean isCacheDisabled()

Is cache disabled boolean.

Returns:

the boolean

getGroupConfigs

public Set<SpringDocConfigProperties.GroupConfig> getGroupConfigs()

Gets group configs.

Returns:

the group configs

setGroupConfigs

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

Sets group configs.

Parameters:

groupConfigs - the group configs

addGroupConfig

public void addGroupConfig(SpringDocConfigProperties.GroupConfig groupConfigs)

Add group config.

Parameters:

groupConfigs - the group configs

getDefaultConsumesMediaType

public String getDefaultConsumesMediaType()

Gets default consumes media type.

Returns:

the default consumes media type

setDefaultConsumesMediaType

public void setDefaultConsumesMediaType(String defaultConsumesMediaType)

Sets default consumes media type.

Parameters:

defaultConsumesMediaType - the default consumes media type

getDefaultProducesMediaType

public String getDefaultProducesMediaType()

Gets default produces media type.

Returns:

the default produces media type

setDefaultProducesMediaType

public void setDefaultProducesMediaType(String defaultProducesMediaType)

Sets default produces media type.

Parameters:

defaultProducesMediaType - the default produces media type

isOverrideWithGenericResponse

public boolean isOverrideWithGenericResponse()

Is override with generic response boolean.

Returns:

the boolean

setOverrideWithGenericResponse

public void setOverrideWithGenericResponse(boolean overrideWithGenericResponse)

Sets override with generic response.

Parameters:

overrideWithGenericResponse - the override with generic response

isDefaultOverrideWithGenericResponse

public boolean isDefaultOverrideWithGenericResponse()

Gets default override with generic response.

Returns:

the default override with generic response

isRemoveBrokenReferenceDefinitions

public boolean isRemoveBrokenReferenceDefinitions()

Is remove broken reference definitions boolean.

Returns:

the boolean

setRemoveBrokenReferenceDefinitions

public void setRemoveBrokenReferenceDefinitions(boolean removeBrokenReferenceDefinitions)

Sets remove broken reference definitions.

Parameters:

removeBrokenReferenceDefinitions - the remove broken reference definitions

isWriterWithOrderByKeys

public boolean isWriterWithOrderByKeys()

Is writer wither order by keys boolean.

Returns:

the boolean

setWriterWithOrderByKeys

public void setWriterWithOrderByKeys(boolean writerWithOrderByKeys)

Sets writer wither order by keys.

Parameters:

writerWithOrderByKeys - the writer wither order by keys

isWriterWithDefaultPrettyPrinter

public boolean isWriterWithDefaultPrettyPrinter()

Is writer with default pretty printer boolean.

Returns:

the boolean

setWriterWithDefaultPrettyPrinter

public void setWriterWithDefaultPrettyPrinter(boolean writerWithDefaultPrettyPrinter)

Sets writer with default pretty printer.

Parameters:

writerWithDefaultPrettyPrinter - the writer with default pretty printer

isDisableI18n

public boolean isDisableI18n()

Is disable i 18 n boolean.

Returns:

the boolean

setDisableI18n

public void setDisableI18n(boolean disableI18n)

Sets disable i 18 n.

Parameters:

disableI18n - the disable i 18 n

isPreLoadingEnabled

public boolean isPreLoadingEnabled()

Is pre loading enabled boolean.

Returns:

the boolean

getPreLoadingLocales

public List<String> getPreLoadingLocales()

locale list to pre-loading.

Returns:

the Locales

setPreLoadingEnabled

public void setPreLoadingEnabled(boolean preLoadingEnabled)

Sets locale list to pre-loading.

Parameters:

preLoadingEnabled - the Locales

setPreLoadingLocales

public void setPreLoadingLocales(List<String> preLoadingLocales)

Sets pre loading locales.

Parameters:

preLoadingLocales - the pre loading locales

isShowOauth2Endpoints

public boolean isShowOauth2Endpoints()

Is show oauth 2 endpoints boolean.

Returns:

the boolean

setShowOauth2Endpoints

public void setShowOauth2Endpoints(boolean showOauth2Endpoints)

Sets show oauth 2 endpoints.

Parameters:

showOauth2Endpoints - the show oauth 2 endpoints

getSpecVersion

public io.swagger.v3.oas.models.SpecVersion getSpecVersion()

Gets spec version.

Returns:

the spec version

isOpenapi31

public boolean isOpenapi31()

Is openapi 31 boolean.

Returns:

the boolean