org.apache.cxf.jaxrs.swagger

Class Swagger2Feature

java.lang.Object

javax.xml.ws.WebServiceFeature

org.apache.cxf.feature.AbstractFeature

org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature

org.apache.cxf.jaxrs.swagger.Swagger2Feature

All Implemented Interfaces:

org.apache.cxf.feature.Feature, org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

public class Swagger2Feature
extends AbstractSwaggerFeature
implements org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Swagger2Feature.DefaultApplication
protected class	Swagger2Feature.ReaderConfigFilter
protected static class	Swagger2Feature.SwaggerContainerRequestFilter

Nested classes/interfaces inherited from interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

org.apache.cxf.jaxrs.swagger.SwaggerUiSupport.Registration

Field Summary

Fields inherited from class org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature

licenseWasSet

Fields inherited from class javax.xml.ws.WebServiceFeature

enabled

Fields inherited from interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

SUPPORT_UI_PROPERTY

Constructor Summary

Constructors

Constructor and Description
Swagger2Feature()

Method Summary

Modifier and Type	Method and Description
protected void	addSwaggerResource(org.apache.cxf.endpoint.Server server, org.apache.cxf.Bus bus)
protected void	calculateDefaultBasePath(org.apache.cxf.endpoint.Server server)
String	findSwaggerUiRoot()
Swagger2Customizer	getCustomizer()
String	getHost()
String	getIgnoreRoutes()
String	getPropertiesLocation()
String[]	getSchemes()
protected Properties	getSwaggerProperties(org.apache.cxf.Bus bus)
Map<String,String>	getSwaggerUiMediaTypes()
protected void	initBeanConfig(io.swagger.jaxrs.config.BeanConfig beanConfig, Properties props)
Boolean	isPrettyPrint()
boolean	isScan()
boolean	isScanAllResources()
Boolean	isSupportSwaggerUi()
Boolean	isUsePathBasedConfig()
protected void	setBasePathByAddress(String address)
void	setCustomizer(Swagger2Customizer customizer)
void	setHost(String host)
void	setIgnoreRoutes(String ignoreRoutes)
void	setPrettyPrint(Boolean prettyPrint)
void	setPropertiesLocation(String propertiesLocation)
void	setScan(boolean scan)
void	setScanAllResources(boolean scanAllResources)
void	setSchemes(String[] schemes)
void	setSecurityDefinitions(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> securityDefinitions)
void	setSupportSwaggerUi(boolean supportSwaggerUi)
void	setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact) Set SwaggerUI Maven group and artifact using the "groupId/artifactId" format.
void	setSwaggerUiMediaTypes(Map<String,String> swaggerUiMediaTypes)
void	setSwaggerUiVersion(String swaggerUiVersion)
void	setUsePathBasedConfig(Boolean usePathBasedConfig)

Methods inherited from class org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature

getBasePath, getContact, getDescription, getFilterClass, getLicense, getLicenseUrl, getResourcePackage, getTermsOfServiceUrl, getTitle, getVersion, initialize, isActivateOnlyIfJaxrsSupported, isRunAsFilter, setActivateOnlyIfJaxrsSupported, setBasePath, setContact, setDescription, setFilterClass, setLicense, setLicenseUrl, setResourcePackage, setRunAsFilter, setTermsOfServiceUrl, setTitle, setVersion

Methods inherited from class org.apache.cxf.feature.AbstractFeature

getActive, getID, initialize, initialize, initialize, initializeProvider

Methods inherited from class javax.xml.ws.WebServiceFeature

isEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

checkSupportSwaggerUiProp, getSwaggerUi

Constructor Detail

Swagger2Feature

public Swagger2Feature()

Method Detail

calculateDefaultBasePath

protected void calculateDefaultBasePath(org.apache.cxf.endpoint.Server server)

Overrides:

calculateDefaultBasePath in class AbstractSwaggerFeature

addSwaggerResource

protected void addSwaggerResource(org.apache.cxf.endpoint.Server server,
                                  org.apache.cxf.Bus bus)

Specified by:

addSwaggerResource in class AbstractSwaggerFeature

getSwaggerProperties

protected Properties getSwaggerProperties(org.apache.cxf.Bus bus)

initBeanConfig

protected void initBeanConfig(io.swagger.jaxrs.config.BeanConfig beanConfig,
                              Properties props)

isUsePathBasedConfig

public Boolean isUsePathBasedConfig()

setUsePathBasedConfig

public void setUsePathBasedConfig(Boolean usePathBasedConfig)

getHost

public String getHost()

setHost

public void setHost(String host)

getSchemes

public String[] getSchemes()

setSchemes

public void setSchemes(String[] schemes)

isPrettyPrint

public Boolean isPrettyPrint()

setPrettyPrint

public void setPrettyPrint(Boolean prettyPrint)

getCustomizer

public Swagger2Customizer getCustomizer()

setCustomizer

public void setCustomizer(Swagger2Customizer customizer)

isScanAllResources

public boolean isScanAllResources()

setScanAllResources

public void setScanAllResources(boolean scanAllResources)

getIgnoreRoutes

public String getIgnoreRoutes()

setIgnoreRoutes

public void setIgnoreRoutes(String ignoreRoutes)

setBasePathByAddress

protected void setBasePathByAddress(String address)

Specified by:

setBasePathByAddress in class AbstractSwaggerFeature

setSwaggerUiMavenGroupAndArtifact

public void setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact)

Set SwaggerUI Maven group and artifact using the "groupId/artifactId" format.

Parameters:

swaggerUiMavenGroupAndArtifact -

setSwaggerUiVersion

public void setSwaggerUiVersion(String swaggerUiVersion)

setSupportSwaggerUi

public void setSupportSwaggerUi(boolean supportSwaggerUi)

isSupportSwaggerUi

public Boolean isSupportSwaggerUi()

Specified by:

isSupportSwaggerUi in interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

setSwaggerUiMediaTypes

public void setSwaggerUiMediaTypes(Map<String,String> swaggerUiMediaTypes)

getSwaggerUiMediaTypes

public Map<String,String> getSwaggerUiMediaTypes()

Specified by:

getSwaggerUiMediaTypes in interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

setSecurityDefinitions

public void setSecurityDefinitions(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> securityDefinitions)

getPropertiesLocation

public String getPropertiesLocation()

setPropertiesLocation

public void setPropertiesLocation(String propertiesLocation)

isScan

public boolean isScan()

setScan

public void setScan(boolean scan)

findSwaggerUiRoot

public String findSwaggerUiRoot()

Specified by:

findSwaggerUiRoot in interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport