Package org.apache.cxf.jaxrs.openapi
Class OpenApiCustomizer
java.lang.Object
org.apache.cxf.jaxrs.openapi.OpenApiCustomizer
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
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 Details
-
dynamicBasePath
protected boolean dynamicBasePath -
replaceTags
protected boolean replaceTags -
javadocProvider
protected org.apache.cxf.jaxrs.model.doc.DocumentationProvider javadocProvider -
cris
-
applicationPath
-
-
Constructor Details
-
OpenApiCustomizer
public OpenApiCustomizer()
-
-
Method Details
-
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
-
addParameters
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) -
setJavaDocPath
- Throws:
Exception
-
setJavaDocPaths
- Throws:
Exception
-
setJavaDocURLs
-
setApplicationInfo
public void setApplicationInfo(org.apache.cxf.jaxrs.model.ApplicationInfo application) -
createMessageContext
protected org.apache.cxf.jaxrs.ext.MessageContext createMessageContext()
-