org.apache.cxf.jaxrs.swagger

Class Swagger2Customizer

java.lang.Object

org.apache.cxf.jaxrs.swagger.Swagger2Customizer

public class Swagger2Customizer
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	applyDefaultVersion
protected io.swagger.jaxrs.config.BeanConfig	beanConfig
protected List<ClassResourceInfo>	cris
protected boolean	dynamicBasePath
protected DocumentationProvider	javadocProvider
protected boolean	replaceTags

Constructor Summary

Constructors

Constructor and Description
Swagger2Customizer()

Method Summary

Modifier and Type	Method and Description
protected void	addParameters(List<io.swagger.models.parameters.Parameter> parameters) Allows to add parameters to the list, related to an Operation instance; the method is invoked for all instances available.
protected void	applyDefaultVersion(io.swagger.models.Swagger data)
io.swagger.models.Swagger	customize(io.swagger.models.Swagger data)
protected String	getNormalizedPath(String classResourcePath, String operationResourcePath)
void	setApplyDefaultVersion(boolean applyDefaultVersion)
void	setBeanConfig(io.swagger.jaxrs.config.BeanConfig beanConfig)
void	setClassResourceInfos(List<ClassResourceInfo> classResourceInfos)
void	setDynamicBasePath(boolean dynamicBasePath)
void	setJavaDocPath(String javaDocPath)
void	setJavaDocPaths(String... javaDocPaths)
void	setJavadocProvider(DocumentationProvider javadocProvider)
void	setJavaDocURLs(URL[] javaDocURLs)
void	setReplaceTags(boolean replaceTags)

Methods inherited from class java.lang.Object

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

Field Detail

dynamicBasePath

protected boolean dynamicBasePath

replaceTags

protected boolean replaceTags

applyDefaultVersion

protected boolean applyDefaultVersion

javadocProvider

protected DocumentationProvider javadocProvider

cris

protected List<ClassResourceInfo> cris

beanConfig

protected io.swagger.jaxrs.config.BeanConfig beanConfig

Constructor Detail

Swagger2Customizer

public Swagger2Customizer()

Method Detail

customize

public io.swagger.models.Swagger customize(io.swagger.models.Swagger data)

getNormalizedPath

protected String getNormalizedPath(String classResourcePath,
                                   String operationResourcePath)

applyDefaultVersion

protected void applyDefaultVersion(io.swagger.models.Swagger data)

addParameters

protected void addParameters(List<io.swagger.models.parameters.Parameter> parameters)

Allows to add parameters to the list, related to an Operation instance; the method is invoked for all instances available.

Parameters:

parameters - list of parameters defined for an Operation

See Also:

HeaderParameter, CookieParameter, PathParameter, BodyParameter, QueryParameter, RefParameter

setDynamicBasePath

public void setDynamicBasePath(boolean dynamicBasePath)

setReplaceTags

public void setReplaceTags(boolean replaceTags)

setJavadocProvider

public void setJavadocProvider(DocumentationProvider javadocProvider)

setClassResourceInfos

public void setClassResourceInfos(List<ClassResourceInfo> classResourceInfos)

setJavaDocPath

public void setJavaDocPath(String javaDocPath)
                    throws Exception

Throws:

Exception

setJavaDocPaths

public void setJavaDocPaths(String... javaDocPaths)
                     throws Exception

Throws:

Exception

setJavaDocURLs

public void setJavaDocURLs(URL[] javaDocURLs)

setBeanConfig

public void setBeanConfig(io.swagger.jaxrs.config.BeanConfig beanConfig)

setApplyDefaultVersion

public void setApplyDefaultVersion(boolean applyDefaultVersion)