Package io.swagger.v3.oas.integration

Class SwaggerConfiguration

java.lang.Object

io.swagger.v3.oas.integration.SwaggerConfiguration

All Implemented Interfaces:

OpenAPIConfiguration

public class SwaggerConfiguration
extends Object
implements OpenAPIConfiguration

Constructor Summary

Constructors

Constructor	Description
SwaggerConfiguration()

Method Summary

Modifier and Type	Method	Description
SwaggerConfiguration	alwaysResolveAppPath(Boolean alwaysResolveAppPath)
SwaggerConfiguration	cacheTTL(Long cacheTTL)
SwaggerConfiguration	convertToOpenAPI31(Boolean convertToOpenAPI31)
SwaggerConfiguration	defaultResponseCode(String defaultResponseCode)
SwaggerConfiguration	filterClass(String filterClass)
Long	getCacheTTL()
String	getDefaultResponseCode()
String	getFilterClass()
String	getId()
Collection<String>	getIgnoredRoutes()
Set<String>	getModelConverterClasses()
String	getObjectMapperProcessorClass()
OpenAPI	getOpenAPI()
String	getReaderClass()
Set<String>	getResourceClasses()
Set<String>	getResourcePackages()
String	getScannerClass()
Map<String,Object>	getUserDefinedOptions()
SwaggerConfiguration	id(String id)
SwaggerConfiguration	ignoredRoutes(Collection<String> ignoredRoutes)
Boolean	isAlwaysResolveAppPath()
Boolean	isConvertToOpenAPI31()
Boolean	isOpenAPI31()
Boolean	isPrettyPrint()
Boolean	isReadAllResources()
Boolean	isSkipResolveAppPath()
Boolean	isSortOutput()
SwaggerConfiguration	modelConverterClasses(Set<String> modelConverterClasses)
SwaggerConfiguration	objectMapperProcessorClass(String objectMapperProcessorClass)
SwaggerConfiguration	openAPI(OpenAPI openAPI)
SwaggerConfiguration	openAPI31(Boolean openAPI31)
SwaggerConfiguration	prettyPrint(Boolean prettyPrint)
SwaggerConfiguration	readAllResources(Boolean readAllResources)
SwaggerConfiguration	readerClass(String readerClass)
SwaggerConfiguration	resourceClasses(Set<String> resourceClasses)
SwaggerConfiguration	resourcePackages(Set<String> resourcePackages)
SwaggerConfiguration	scannerClass(String scannerClass)
void	setAlwaysResolveAppPath(Boolean alwaysResolveAppPath)
void	setCacheTTL(Long cacheTTL)
void	setConvertToOpenAPI31(Boolean convertToOpenAPI31)
void	setDefaultResponseCode(String defaultResponseCode)
void	setFilterClass(String filterClass)
void	setId(String id)
void	setIgnoredRoutes(Collection<String> ignoredRoutes)
void	setModelConverterClassess(Set<String> modelConverterClasses)
void	setObjectMapperProcessorClass(String objectMapperProcessorClass)
void	setOpenAPI(OpenAPI openAPI)
void	setOpenAPI31(Boolean openAPI31)
void	setPrettyPrint(Boolean prettyPrint)
void	setReadAllResources(Boolean readAllResources)
void	setReaderClass(String readerClass)
void	setResourceClasses(Set<String> resourceClasses)
void	setResourcePackages(Set<String> resourcePackages)
void	setScannerClass(String scannerClass)
void	setSkipResolveAppPath(Boolean skipResolveAppPath)
void	setSortOutput(Boolean sortOutput)
void	setUserDefinedOptions(Map<String,Object> userDefinedOptions)
SwaggerConfiguration	skipResolveAppPath(Boolean skipResolveAppPath)
SwaggerConfiguration	sortOutput(Boolean sortOutput)
SwaggerConfiguration	userDefinedOptions(Map<String,Object> userDefinedOptions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwaggerConfiguration

public SwaggerConfiguration()

Method Detail

getDefaultResponseCode

public String getDefaultResponseCode()

Specified by:

getDefaultResponseCode in interface OpenAPIConfiguration

setDefaultResponseCode

public void setDefaultResponseCode(String defaultResponseCode)

defaultResponseCode

public SwaggerConfiguration defaultResponseCode(String defaultResponseCode)

getCacheTTL

public Long getCacheTTL()

Specified by:

getCacheTTL in interface OpenAPIConfiguration

setCacheTTL

public void setCacheTTL(Long cacheTTL)

cacheTTL

public SwaggerConfiguration cacheTTL(Long cacheTTL)

isReadAllResources

public Boolean isReadAllResources()

Specified by:

isReadAllResources in interface OpenAPIConfiguration

setReadAllResources

public void setReadAllResources(Boolean readAllResources)

readAllResources

public SwaggerConfiguration readAllResources(Boolean readAllResources)

getIgnoredRoutes

public Collection<String> getIgnoredRoutes()

Specified by:

getIgnoredRoutes in interface OpenAPIConfiguration

setIgnoredRoutes

public void setIgnoredRoutes(Collection<String> ignoredRoutes)

ignoredRoutes

public SwaggerConfiguration ignoredRoutes(Collection<String> ignoredRoutes)

isPrettyPrint

public Boolean isPrettyPrint()

Specified by:

isPrettyPrint in interface OpenAPIConfiguration

setPrettyPrint

public void setPrettyPrint(Boolean prettyPrint)

prettyPrint

public SwaggerConfiguration prettyPrint(Boolean prettyPrint)

getOpenAPI

public OpenAPI getOpenAPI()

Specified by:

getOpenAPI in interface OpenAPIConfiguration

setOpenAPI

public void setOpenAPI(OpenAPI openAPI)

openAPI

public SwaggerConfiguration openAPI(OpenAPI openAPI)

getReaderClass

public String getReaderClass()

Specified by:

getReaderClass in interface OpenAPIConfiguration

setReaderClass

public void setReaderClass(String readerClass)

getScannerClass

public String getScannerClass()

Specified by:

getScannerClass in interface OpenAPIConfiguration

setScannerClass

public void setScannerClass(String scannerClass)

getUserDefinedOptions

public Map<String,Object> getUserDefinedOptions()

Specified by:

getUserDefinedOptions in interface OpenAPIConfiguration

setUserDefinedOptions

public void setUserDefinedOptions(Map<String,Object> userDefinedOptions)

scannerClass

public SwaggerConfiguration scannerClass(String scannerClass)

readerClass

public SwaggerConfiguration readerClass(String readerClass)

userDefinedOptions

public SwaggerConfiguration userDefinedOptions(Map<String,Object> userDefinedOptions)

getResourcePackages

public Set<String> getResourcePackages()

Specified by:

getResourcePackages in interface OpenAPIConfiguration

setResourcePackages

public void setResourcePackages(Set<String> resourcePackages)

resourcePackages

public SwaggerConfiguration resourcePackages(Set<String> resourcePackages)

getResourceClasses

public Set<String> getResourceClasses()

Specified by:

getResourceClasses in interface OpenAPIConfiguration

setResourceClasses

public void setResourceClasses(Set<String> resourceClasses)

resourceClasses

public SwaggerConfiguration resourceClasses(Set<String> resourceClasses)

getFilterClass

public String getFilterClass()

Specified by:

getFilterClass in interface OpenAPIConfiguration

setFilterClass

public void setFilterClass(String filterClass)

filterClass

public SwaggerConfiguration filterClass(String filterClass)

id

public SwaggerConfiguration id(String id)

getId

public String getId()

setId

public void setId(String id)

objectMapperProcessorClass

public SwaggerConfiguration objectMapperProcessorClass(String objectMapperProcessorClass)

Since:

2.0.6

getObjectMapperProcessorClass

public String getObjectMapperProcessorClass()

Specified by:

getObjectMapperProcessorClass in interface OpenAPIConfiguration

Since:

2.0.6

setObjectMapperProcessorClass

public void setObjectMapperProcessorClass(String objectMapperProcessorClass)

Since:

2.0.6

getModelConverterClasses

public Set<String> getModelConverterClasses()

Specified by:

getModelConverterClasses in interface OpenAPIConfiguration

Since:

2.0.6

setModelConverterClassess

public void setModelConverterClassess(Set<String> modelConverterClasses)

Since:

2.0.6

modelConverterClasses

public SwaggerConfiguration modelConverterClasses(Set<String> modelConverterClasses)

Since:

2.0.6

isSortOutput

public Boolean isSortOutput()

Specified by:

isSortOutput in interface OpenAPIConfiguration

Since:

2.1.6

setSortOutput

public void setSortOutput(Boolean sortOutput)

Since:

2.1.6

sortOutput

public SwaggerConfiguration sortOutput(Boolean sortOutput)

Since:

2.1.6

isAlwaysResolveAppPath

public Boolean isAlwaysResolveAppPath()

Specified by:

isAlwaysResolveAppPath in interface OpenAPIConfiguration

Since:

2.1.9

setAlwaysResolveAppPath

public void setAlwaysResolveAppPath(Boolean alwaysResolveAppPath)

Since:

2.1.9

alwaysResolveAppPath

public SwaggerConfiguration alwaysResolveAppPath(Boolean alwaysResolveAppPath)

Since:

2.1.9

isSkipResolveAppPath

public Boolean isSkipResolveAppPath()

Specified by:

isSkipResolveAppPath in interface OpenAPIConfiguration

Since:

2.1.15

setSkipResolveAppPath

public void setSkipResolveAppPath(Boolean skipResolveAppPath)

Since:

2.1.15

skipResolveAppPath

public SwaggerConfiguration skipResolveAppPath(Boolean skipResolveAppPath)

Since:

2.1.15

isOpenAPI31

public Boolean isOpenAPI31()

Specified by:

isOpenAPI31 in interface OpenAPIConfiguration

Since:

2.1.9

setOpenAPI31

public void setOpenAPI31(Boolean openAPI31)

Since:

2.1.9

openAPI31

public SwaggerConfiguration openAPI31(Boolean openAPI31)

Since:

2.1.9

isConvertToOpenAPI31

public Boolean isConvertToOpenAPI31()

Specified by:

isConvertToOpenAPI31 in interface OpenAPIConfiguration

Since:

2.2.12

setConvertToOpenAPI31

public void setConvertToOpenAPI31(Boolean convertToOpenAPI31)

Since:

2.2.12

convertToOpenAPI31

public SwaggerConfiguration convertToOpenAPI31(Boolean convertToOpenAPI31)

Since:

2.2.12