Package org.apache.cxf.jaxrs.openapi

Class OpenApiCustomizer

java.lang.Object
org.apache.cxf.jaxrs.openapi.OpenApiCustomizer
public class OpenApiCustomizer extends Object

  • Field Details

    • dynamicBasePath

      protected boolean dynamicBasePath

    • replaceTags

      protected boolean replaceTags

    • javadocProvider

      protected DocumentationProvider javadocProvider

    • cris

      protected List<ClassResourceInfo> cris

    • applicationPath

      protected String 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, 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()