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]

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OpenApiConfig.AutoInheritance
static class	OpenApiConfig.DuplicateOperationIdBehavior
static class	OpenApiConfig.OperationIdStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static OpenApiConfig.DuplicateOperationIdBehavior	DUPLICATE_OPERATION_ID_BEHAVIOR_DEFAULT
static Integer	MAXIMUM_STATIC_FILE_SIZE_DEFAULT

Method Summary

Modifier and Type	Method	Description
default Optional<Boolean>	allowNakedPathParameter()
default boolean	applicationPathDisable()
default boolean	arrayReferencesEnable()
default String	customSchemaRegistryClass()
default void	doAllowNakedPathParameter()
default String	filter()
static OpenApiConfig	fromConfig(org.eclipse.microprofile.config.Config config)
default OpenApiConfig.AutoInheritance	getAutoInheritance()
<R,T> T	getConfigValue(String propertyName, Class<R> type, Function<R,T> converter, Supplier<T> defaultValue)
default <T> T	getConfigValue(String propertyName, Class<T> type, Supplier<T> defaultValue)
<R,T> Map<String,T>	getConfigValueMap(String propertyNamePrefix, Class<R> type, Function<R,T> converter)
default Optional<String[]>	getDefaultConsumes()
default Optional<String[]>	getDefaultPrimitivesConsumes()
default Optional<String[]>	getDefaultPrimitivesProduces()
default Optional<String[]>	getDefaultProduces()
default Optional<String[]>	getDefaultStreamingConsumes()
default Optional<String[]>	getDefaultStreamingProduces()
default OpenApiConfig.DuplicateOperationIdBehavior	getDuplicateOperationIdBehavior()
default String	getInfoContactEmail()
default String	getInfoContactName()
default String	getInfoContactUrl()
default String	getInfoDescription()
default String	getInfoLicenseName()
default String	getInfoLicenseUrl()
default String	getInfoTermsOfService()
default String	getInfoTitle()
default String	getInfoVersion()
default Integer	getMaximumStaticFileSize()
default String	getOpenApiVersion()
default OpenApiConfig.OperationIdStrategy	getOperationIdStrategy()
default Set<String>	getScanExcludeProfiles()
default Set<String>	getScanProfiles()
default Map<String,String>	getScanResourceClasses()
default Map<String,String>	getSchemas()
default String	modelReader()
default List<String>	operationServers(String operationId)
default List<String>	pathServers(String path)
default boolean	privatePropertiesEnable()
default String	propertyNamingStrategy()
default boolean	removeUnusedSchemas()
default boolean	scanBeanValidation()
default Set<String>	scanClasses()
default boolean	scanDependenciesDisable()
default Set<String>	scanDependenciesJars()
default boolean	scanDisable()
default Set<String>	scanExcludeClasses()
default Set<String>	scanExcludePackages()
default Set<String>	scanPackages()
default List<String>	servers()
void	setAllowNakedPathParameter(Boolean allowNakedPathParameter)
default boolean	sortedPropertiesEnable()
default List<String>	toList(String[] items)
default Set<String>	toSet(String[] items)

Field Detail

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 Detail

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)

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()

getInfoContactEmail

default String getInfoContactEmail()

getInfoContactName

default String getInfoContactName()

getInfoContactUrl

default String getInfoContactUrl()

getInfoLicenseName

default String getInfoLicenseName()

getInfoLicenseUrl

default String getInfoLicenseUrl()

getOperationIdStrategy

default OpenApiConfig.OperationIdStrategy 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()

getMaximumStaticFileSize

default Integer getMaximumStaticFileSize()

getAutoInheritance

default OpenApiConfig.AutoInheritance getAutoInheritance()

toSet

default Set<String> toSet(String[] items)

toList

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