Package org.springdoc.core

Class SpringDocConfigProperties

java.lang.Object
org.springdoc.core.SpringDocConfigProperties
@Lazy(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

  • Constructor Details

    • SpringDocConfigProperties

      public SpringDocConfigProperties()

  • Method Details

    • getOverrideWithGenericResponse

      public Boolean getOverrideWithGenericResponse()
      Gets override with generic response.
      Returns:
      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

    • getSortConverter

      public SpringDocConfigProperties.ModelConverters.SortConverter getSortConverter()
      Gets sort converter.
      Returns:
      the sort converter

    • setSortConverter

      public void setSortConverter(SpringDocConfigProperties.ModelConverters.SortConverter sortConverter)
      Sets sort converter.
      Parameters:
      sortConverter - the sort converter

    • 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

    • isDefaultFlatParamObject

      public boolean isDefaultFlatParamObject()
      Is default flat param object
      Returns:
      the boolean

    • setDefaultFlatParamObject

      public void setDefaultFlatParamObject(boolean defaultFlatParamObject)
      Sets default flat param object.
      Parameters:
      defaultFlatParamObject - the default flat param object

    • 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 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

    • 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

    • setPreLoadingEnabled

      public void setPreLoadingEnabled(boolean preLoadingEnabled)
      Sets pre loading enabled.
      Parameters:
      preLoadingEnabled - the pre loading enabled

    • isShowOauth2Endpoints

      public boolean isShowOauth2Endpoints()

    • setShowOauth2Endpoints

      public void setShowOauth2Endpoints(boolean showOauth2Endpoint)