Package io.smallrye.openapi.api

Interface OpenApiConfig

All Known Implementing Classes:
OpenApiConfigImpl
public interface OpenApiConfig
Accessor to OpenAPI configuration options. Reference: https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc#list-of-configurable-items
Author:
[email protected]

  • Field Details

    • NEVER_SCAN_CLASSES

      static final Set<String> NEVER_SCAN_CLASSES
      Set of classes which should never be scanned, regardless of user configuration.

    • NEVER_SCAN_PACKAGES

      static final Set<String> NEVER_SCAN_PACKAGES
      Set of packages which should never be scanned, regardless of user configuration.

    • DEFAULT_COMPOSITION_EXCLUDE_PACKAGES

      static final Set<String> DEFAULT_COMPOSITION_EXCLUDE_PACKAGES
      Default set of packages with annotations that should not be checked for nested/composed annotations. For example, the annotations org.jetbrains.annotations.NotNull will not be checked for additional annotations. Generally, only application-provided custom annotations would be used to compose multiple OpenAPI annotations. This list allows the scanner to short-circuit the scanning of an excessive number of annotations.

    • DUPLICATE_OPERATION_ID_BEHAVIOR_DEFAULT

      static final OpenApiConfig.DuplicateOperationIdBehavior DUPLICATE_OPERATION_ID_BEHAVIOR_DEFAULT

    • MAXIMUM_STATIC_FILE_SIZE_DEFAULT

      static final Integer MAXIMUM_STATIC_FILE_SIZE_DEFAULT

  • Method Details

    • fromConfig

      static OpenApiConfig fromConfig(org.eclipse.microprofile.config.Config config)

    • getConfigValue

      <R, T> T getConfigValue(String propertyName, Class<R> type, Function<R,T> converter, Supplier<T> defaultValue)

    • getConfigValues

      <R, T extends Collection<R>> T getConfigValues(String propertyName, Class<R> elementType, Function<List<R>,T> converter, Supplier<T> defaultValue)

    • getConfigValueMap

      <R, T> Map<String,T> getConfigValueMap(String propertyNamePrefix, Class<R> type, Function<R,T> converter)

    • getConfigValue

      default <T> T getConfigValue(String propertyName, Class<T> type, Supplier<T> defaultValue)

    • modelReader

      default String modelReader()

    • filter

      default String filter()

    • scanDisable

      default boolean scanDisable()

    • scanPackages

      default Set<String> scanPackages()

    • scanClasses

      default Set<String> scanClasses()

    • scanExcludePackages

      default Set<String> scanExcludePackages()

    • scanExcludeClasses

      default Set<String> scanExcludeClasses()

    • scanBeanValidation

      default boolean scanBeanValidation()

    • servers

      default List<String> servers()

    • pathServers

      default List<String> pathServers(String path)

    • operationServers

      default List<String> operationServers(String operationId)

    • scanDependenciesDisable

      default boolean scanDependenciesDisable()

    • scanDependenciesJars

      default Set<String> scanDependenciesJars()

    • arrayReferencesEnable

      default boolean arrayReferencesEnable()

    • customSchemaRegistryClass

      default String customSchemaRegistryClass()

    • applicationPathDisable

      default boolean applicationPathDisable()

    • privatePropertiesEnable

      default boolean privatePropertiesEnable()

    • propertyNamingStrategy

      default String propertyNamingStrategy()

    • sortedPropertiesEnable

      default boolean sortedPropertiesEnable()

    • getSchemas

      default Map<String,String> getSchemas()

    • getOpenApiVersion

      default String getOpenApiVersion()

    • getInfoTitle

      default String getInfoTitle()

    • getInfoVersion

      default String getInfoVersion()

    • getInfoDescription

      default String getInfoDescription()

    • getInfoTermsOfService

      default String getInfoTermsOfService()

    • getInfoSummary

      default String getInfoSummary()

    • getInfoContactEmail

      default String getInfoContactEmail()

    • getInfoContactName

      default String getInfoContactName()

    • getInfoContactUrl

      default String getInfoContactUrl()

    • getInfoLicenseName

      default String getInfoLicenseName()

    • getInfoLicenseIdentifier

      default String getInfoLicenseIdentifier()

    • getInfoLicenseUrl

      default String getInfoLicenseUrl()

    • getOperationIdStrategy

      default String getOperationIdStrategy()

    • getDuplicateOperationIdBehavior

      default OpenApiConfig.DuplicateOperationIdBehavior getDuplicateOperationIdBehavior()

    • getDefaultProduces

      default Optional<String[]> getDefaultProduces()

    • getDefaultConsumes

      default Optional<String[]> getDefaultConsumes()

    • getDefaultPrimitivesProduces

      default Optional<String[]> getDefaultPrimitivesProduces()

    • getDefaultPrimitivesConsumes

      default Optional<String[]> getDefaultPrimitivesConsumes()

    • getDefaultStreamingProduces

      default Optional<String[]> getDefaultStreamingProduces()

    • getDefaultStreamingConsumes

      default Optional<String[]> getDefaultStreamingConsumes()

    • allowNakedPathParameter

      default Optional<Boolean> allowNakedPathParameter()

    • setAllowNakedPathParameter

      void setAllowNakedPathParameter(Boolean allowNakedPathParameter)

    • doAllowNakedPathParameter

      default void doAllowNakedPathParameter()

    • getScanProfiles

      default Set<String> getScanProfiles()

    • getScanExcludeProfiles

      default Set<String> getScanExcludeProfiles()

    • getScanResourceClasses

      default Map<String,String> getScanResourceClasses()

    • removeUnusedSchemas

      default boolean removeUnusedSchemas()

    • mergeSchemaExamples

      default boolean mergeSchemaExamples()

    • sortedParametersEnable

      default boolean sortedParametersEnable()

    • genericResponseUseDefault

      default boolean genericResponseUseDefault()

    • yamlAliasExpansionEnable

      default boolean yamlAliasExpansionEnable()

    • getMaximumStaticFileSize

      default Integer getMaximumStaticFileSize()

    • getAutoInheritance

      default OpenApiConfig.AutoInheritance getAutoInheritance()

    • getScanCompositionExcludePackages

      default Set<String> getScanCompositionExcludePackages()

    • toSet

      default Set<String> toSet(List<String> items)

    • toList

      default List<String> toList(List<String> items)