Package 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 Description protected String
applicationPath
protected List<org.apache.cxf.jaxrs.model.ClassResourceInfo>
cris
protected boolean
dynamicBasePath
protected org.apache.cxf.jaxrs.model.doc.DocumentationProvider
javadocProvider
protected boolean
replaceTags
-
Constructor Summary
Constructors Constructor Description OpenApiCustomizer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addParameters(List<io.swagger.v3.oas.models.parameters.Parameter> parameters)
Allows to add parameters to the list, related to anOperation
instance; the method is invoked for all instances available.protected org.apache.cxf.jaxrs.ext.MessageContext
createMessageContext()
io.swagger.v3.oas.integration.api.OpenAPIConfiguration
customize(io.swagger.v3.oas.integration.api.OpenAPIConfiguration configuration)
void
customize(io.swagger.v3.oas.models.OpenAPI oas)
protected void
customizeResponses(io.swagger.v3.oas.models.Operation operation, org.apache.cxf.jaxrs.model.OperationResourceInfo ori)
Allows to customize the responses of the givenOperation
instance; the method is invoked for all instances available.protected String
extractJavadoc(io.swagger.v3.oas.models.Operation operation, org.apache.cxf.jaxrs.model.OperationResourceInfo ori, int paramIdx)
protected String
getNormalizedPath(String classResourcePath, String operationResourcePath)
void
setApplicationInfo(org.apache.cxf.jaxrs.model.ApplicationInfo application)
void
setClassResourceInfos(List<org.apache.cxf.jaxrs.model.ClassResourceInfo> classResourceInfos)
void
setDynamicBasePath(boolean dynamicBasePath)
void
setJavaDocPath(String javaDocPath)
void
setJavaDocPaths(String... javaDocPaths)
void
setJavadocProvider(org.apache.cxf.jaxrs.model.doc.DocumentationProvider javadocProvider)
void
setJavaDocURLs(URL[] javaDocURLs)
void
setReplaceTags(boolean replaceTags)
-
-
-
Field Detail
-
dynamicBasePath
protected boolean dynamicBasePath
-
replaceTags
protected boolean replaceTags
-
javadocProvider
protected org.apache.cxf.jaxrs.model.doc.DocumentationProvider javadocProvider
-
cris
protected List<org.apache.cxf.jaxrs.model.ClassResourceInfo> cris
-
applicationPath
protected String applicationPath
-
-
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, org.apache.cxf.jaxrs.model.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 anOperation
instance; the method is invoked for all instances available.- Parameters:
parameters
- list of parameters defined for anOperation
- See Also:
HeaderParameter
,CookieParameter
,PathParameter
,QueryParameter
-
customizeResponses
protected void customizeResponses(io.swagger.v3.oas.models.Operation operation, org.apache.cxf.jaxrs.model.OperationResourceInfo ori)
Allows to customize the responses of the givenOperation
instance; the method is invoked for all instances available.- Parameters:
operation
- operation instanceori
- CXF data about the given operation instance
-
setDynamicBasePath
public void setDynamicBasePath(boolean dynamicBasePath)
-
setReplaceTags
public void setReplaceTags(boolean replaceTags)
-
setJavadocProvider
public void setJavadocProvider(org.apache.cxf.jaxrs.model.doc.DocumentationProvider javadocProvider)
-
setClassResourceInfos
public void setClassResourceInfos(List<org.apache.cxf.jaxrs.model.ClassResourceInfo> classResourceInfos)
-
setJavaDocPaths
public void setJavaDocPaths(String... javaDocPaths) throws Exception
- Throws:
Exception
-
setJavaDocURLs
public void setJavaDocURLs(URL[] javaDocURLs)
-
setApplicationInfo
public void setApplicationInfo(org.apache.cxf.jaxrs.model.ApplicationInfo application)
-
createMessageContext
protected org.apache.cxf.jaxrs.ext.MessageContext createMessageContext()
-
-