SpringDocConfigProperties (springdoc-openapi-common 1.5.10 API)

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.Webjars` The type Webjars.

Field Summary

Fields
Modifier and Type Field and Description

protected Boolean enableNativeImageSupport
The Enable native support.

Fields
Modifier and Type	Field and Description
`protected Boolean`	`enableNativeImageSupport` The Enable native support.

Constructor Summary

Constructors
Constructor and Description

SpringDocConfigProperties()

Constructors
Constructor and Description
`SpringDocConfigProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`Boolean`	`getEnableNativeImageSupport()` Gets enable native image support.
`List<SpringDocConfigProperties.GroupConfig>`	`getGroupConfigs()` Gets group configs.
`List<String>`	`getHeadersToMatch()` Gets headers to match.
`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>`	`getProducesToMatch()` Gets produces to match.
`SpringDocConfigProperties.Webjars`	`getWebjars()` Gets webjars.
`boolean`	`isAutoTagClasses()` Is auto tag classes boolean.
`boolean`	`isCacheDisabled()` Is cache disabled boolean.
`boolean`	`isModelAndViewAllowed()` Is model and view allowed 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`	`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`	`setDefaultProducesMediaType(String defaultProducesMediaType)` Sets default produces media type.
`void`	`setEnableNativeImageSupport(Boolean enableNativeImageSupport)` Sets enable native image support.
`void`	`setGroupConfigs(List<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`	`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 pre loading enabled.
`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`	`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

- Field Detail
  - enableNativeImageSupport
```
protected Boolean enableNativeImageSupport
```
    The Enable native support.
- Constructor Detail
  - SpringDocConfigProperties
```
public SpringDocConfigProperties()
```
- Method Detail
  - getEnableNativeImageSupport
```
public Boolean getEnableNativeImageSupport()
```
    Gets enable native image support.
    
    Returns:
    
    the enable native image support
  - setEnableNativeImageSupport
```
public void setEnableNativeImageSupport(Boolean enableNativeImageSupport)
```
    Sets enable native image support.
    
    Parameters:
    
    enableNativeImageSupport - the enable native image support
  - 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 List<SpringDocConfigProperties.GroupConfig> getGroupConfigs()
```
    Gets group configs.
    
    Returns:
    
    the group configs
  - setGroupConfigs
```
public void setGroupConfigs(List<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
  - 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
  - setPreLoadingEnabled
```
public void setPreLoadingEnabled(boolean preLoadingEnabled)
```
    Sets pre loading enabled.
    
    Parameters:
    
    preLoadingEnabled - the pre loading enabled
  - isPreLoadingEnabled
```
public boolean isPreLoadingEnabled()
```
    Is pre loading enabled boolean.
    
    Returns:
    
    the boolean

Class SpringDocConfigProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

enableNativeImageSupport

Constructor Detail

SpringDocConfigProperties

Method Detail

getEnableNativeImageSupport

setEnableNativeImageSupport

isUseManagementPort

setUseManagementPort

getProducesToMatch

setProducesToMatch

getHeadersToMatch

setHeadersToMatch

getConsumesToMatch

setConsumesToMatch

isUseFqn

setUseFqn

isAutoTagClasses

setAutoTagClasses

isModelAndViewAllowed

setModelAndViewAllowed

getPackagesToExclude

setPackagesToExclude

getPathsToExclude

setPathsToExclude

isShowLoginEndpoint

setShowLoginEndpoint

getPackagesToScan

setPackagesToScan

isShowActuator

setShowActuator

getWebjars

setWebjars

getApiDocs

setApiDocs

getPathsToMatch

setPathsToMatch

getCache

setCache

isCacheDisabled

getGroupConfigs

setGroupConfigs

addGroupConfig

getDefaultConsumesMediaType

setDefaultConsumesMediaType

getDefaultProducesMediaType

setDefaultProducesMediaType

isOverrideWithGenericResponse

setOverrideWithGenericResponse

isRemoveBrokenReferenceDefinitions

setRemoveBrokenReferenceDefinitions

isWriterWithOrderByKeys

setWriterWithOrderByKeys

isWriterWithDefaultPrettyPrinter

setWriterWithDefaultPrettyPrinter

setPreLoadingEnabled

isPreLoadingEnabled