org.apache.cxf.jaxrs.openapi

Class OpenApiCustomizer

java.lang.Object

org.apache.cxf.jaxrs.openapi.OpenApiCustomizer

public class OpenApiCustomizer
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	applicationPath
protected List<ClassResourceInfo>	cris
protected boolean	dynamicBasePath
protected DocumentationProvider	javadocProvider
protected boolean	replaceTags

Constructor Summary

Constructors

Constructor and Description
OpenApiCustomizer()

Method Summary

Modifier and Type	Method and Description
protected void	addParameters(List<io.swagger.v3.oas.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 MessageContext	createMessageContext()
void	customize(io.swagger.v3.oas.models.OpenAPI oas)
io.swagger.v3.oas.integration.api.OpenAPIConfiguration	customize(io.swagger.v3.oas.integration.api.OpenAPIConfiguration configuration)
protected void	customizeResponses(io.swagger.v3.oas.models.Operation operation, OperationResourceInfo ori) Allows to customize the responses of the given Operation instance; the method is invoked for all instances available.
protected String	extractJavadoc(io.swagger.v3.oas.models.Operation operation, OperationResourceInfo ori, int paramIdx)
protected String	getNormalizedPath(String classResourcePath, String operationResourcePath)
void	setApplicationInfo(ApplicationInfo application)
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

javadocProvider

protected DocumentationProvider javadocProvider

cris

protected List<ClassResourceInfo> cris

applicationPath

protected String applicationPath

Constructor Detail

OpenApiCustomizer

public OpenApiCustomizer()

Method Detail

customize

public io.swagger.v3.oas.integration.api.OpenAPIConfiguration customize(io.swagger.v3.oas.integration.api.OpenAPIConfiguration configuration)

extractJavadoc

protected String extractJavadoc(io.swagger.v3.oas.models.Operation operation,
                                OperationResourceInfo ori,
                                int paramIdx)

customize

public void customize(io.swagger.v3.oas.models.OpenAPI oas)

getNormalizedPath

protected String getNormalizedPath(String classResourcePath,
                                   String operationResourcePath)

addParameters

protected void addParameters(List<io.swagger.v3.oas.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, QueryParameter

customizeResponses

protected void customizeResponses(io.swagger.v3.oas.models.Operation operation,
                                  OperationResourceInfo ori)

Allows to customize the responses of the given Operation instance; the method is invoked for all instances available.

Parameters:

operation - operation instance

ori - CXF data about the given operation instance

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)

setApplicationInfo

public void setApplicationInfo(ApplicationInfo application)

createMessageContext

protected MessageContext createMessageContext()