public class DefaultSwaggerConfiguration extends io.swagger.jaxrs.config.BeanConfig implements SwaggerConfiguration
SwaggerConfiguration implementation.| Constructor and Description |
|---|
DefaultSwaggerConfiguration()
Default constructor.
|
DefaultSwaggerConfiguration(io.swagger.config.SwaggerConfig parent)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
io.swagger.models.ExternalDocs |
getExternalDocs()
Get the external docs reference
|
Collection<String> |
getIgnoredRoutes()
Get the API routes to ignore.
|
String |
getReaderClass()
Get the API reader class.
|
Set<String> |
getResourcePackages()
Get the package names to use to filter the API resource classes.
|
String |
getScannerClass()
Get the API scanner class.
|
List<io.swagger.models.SecurityRequirement> |
getSecurity()
Get the security requirements.
|
boolean |
isPrettyPrint()
Get whether to pretty print the API output.
|
boolean |
isReadAllResources()
Get whether to read all the API resource classes, diregarding the Api annotation.
|
void |
setExternalDocs(io.swagger.models.ExternalDocs externalDocs)
Set the external documentation reference.
|
void |
setIgnoredRoutes(Collection<String> ignoredRoutes)
Set the API definition routes to ignore.
|
void |
setPrettyPrint(boolean prettyPrint)
Set whether to pretty print the API output.
|
void |
setReadAllResources(boolean readAllResources)
Set whether to read all the API resource classes, diregarding the Api annotation.
|
void |
setReaderClass(String readerClass)
Set the API reader class.
|
void |
setResourcePackages(Set<String> resourcePackages)
Set the package names to use to filter the API resource classes.
|
void |
setScannerClass(String scannerClass)
Set the API scanner class.
|
void |
setSecurity(List<io.swagger.models.SecurityRequirement> security)
Set the security requirements.
|
classes, configure, getBasePath, getConfigId, getContact, getContextId, getDescription, getExpandSuperTypes, getFilterClass, getHost, getInfo, getLicense, getLicenseUrl, getResourcePackage, getScan, getScannerId, getSchemes, getSwagger, getTermsOfServiceUrl, getTitle, getVersion, isUsePathBasedConfig, scanAndRead, setBasePath, setConfigId, setContact, setContextId, setDescription, setExpandSuperTypes, setFilterClass, setHost, setInfo, setLicense, setLicenseUrl, setPrettyPrint, setResourcePackage, setScan, setScan, setScannerId, setSchemes, setServletConfig, setTermsOfServiceUrl, setTitle, setUsePathBasedConfig, setVersionpublic DefaultSwaggerConfiguration()
public DefaultSwaggerConfiguration(io.swagger.config.SwaggerConfig parent)
parent - The paretn configuration from which to inherit the configuration attributespublic Set<String> getResourcePackages()
SwaggerConfigurationgetResourcePackages in interface SwaggerConfigurationpublic void setResourcePackages(Set<String> resourcePackages)
setResourcePackages in interface SwaggerConfigurationresourcePackages - the package names to setpublic String getReaderClass()
SwaggerConfigurationgetReaderClass in interface SwaggerConfigurationpublic void setReaderClass(String readerClass)
readerClass - the reader class to setpublic String getScannerClass()
SwaggerConfigurationgetScannerClass in interface SwaggerConfigurationpublic void setScannerClass(String scannerClass)
scannerClass - the scanner class to setpublic Collection<String> getIgnoredRoutes()
SwaggerConfigurationgetIgnoredRoutes in interface SwaggerConfigurationpublic void setIgnoredRoutes(Collection<String> ignoredRoutes)
ignoredRoutes - the ignored routes to setpublic boolean isReadAllResources()
SwaggerConfigurationisReadAllResources in interface SwaggerConfigurationpublic void setReadAllResources(boolean readAllResources)
readAllResources - whether to read all the API resource classespublic boolean isPrettyPrint()
SwaggerConfigurationisPrettyPrint in interface SwaggerConfigurationpublic void setPrettyPrint(boolean prettyPrint)
setPrettyPrint in interface SwaggerConfigurationsetPrettyPrint in interface io.swagger.config.ScannersetPrettyPrint in class io.swagger.jaxrs.config.AbstractScannerprettyPrint - whether to pretty print the API outputpublic io.swagger.models.ExternalDocs getExternalDocs()
SwaggerConfigurationgetExternalDocs in interface SwaggerConfigurationpublic void setExternalDocs(io.swagger.models.ExternalDocs externalDocs)
externalDocs - the external docs to setpublic List<io.swagger.models.SecurityRequirement> getSecurity()
getSecurity in interface SwaggerConfigurationpublic void setSecurity(List<io.swagger.models.SecurityRequirement> security)
security - the security requirements to setCopyright © 2019 The Holon Platform. All rights reserved.