Package io.jmix.rest.impl.openapi

Class OpenAPIGeneratorImpl

java.lang.Object
io.jmix.rest.impl.openapi.OpenAPIGeneratorImpl
All Implemented Interfaces:
OpenAPIGenerator
@Component("rest_OpenAPIGenerator") public class OpenAPIGeneratorImpl extends Object implements OpenAPIGenerator

  • Field Details

  • Constructor Details

    • OpenAPIGeneratorImpl

      public OpenAPIGeneratorImpl()

  • Method Details

    • generateOpenAPI

      public io.swagger.v3.oas.models.OpenAPI generateOpenAPI()
      Specified by:
      generateOpenAPI in interface OpenAPIGenerator
      Returns:
      a OpenAPI object that can be transformed to JSON or YAML version of documentation

    • checkInitialized

      protected void checkInitialized()

    • init

      protected void init()

    • buildEntitySchema

      protected void buildEntitySchema(io.swagger.v3.oas.models.OpenAPI openAPI)

    • buildServer

      protected void buildServer(io.swagger.v3.oas.models.OpenAPI openAPI)

    • buildInfo

      protected void buildInfo(io.swagger.v3.oas.models.OpenAPI openAPI)

    • buildErrorSchema

      protected void buildErrorSchema(io.swagger.v3.oas.models.OpenAPI openAPI)

    • buildTags

      protected void buildTags(io.swagger.v3.oas.models.OpenAPI openAPI)

    • buildEntitiesPaths

      protected void buildEntitiesPaths(io.swagger.v3.oas.models.OpenAPI openAPI)

    • buildEntitySchema

      protected void buildEntitySchema(io.swagger.v3.oas.models.OpenAPI openAPI, MetaClass entityClass)

    • buildEntityPath

      protected void buildEntityPath(io.swagger.v3.oas.models.OpenAPI openAPI, MetaClass entityClass)

    • buildEntityRUDPaths

      protected void buildEntityRUDPaths(io.swagger.v3.oas.models.OpenAPI openAPI, MetaClass entityClass)

    • buildEntityFilterPaths

      protected void buildEntityFilterPaths(io.swagger.v3.oas.models.OpenAPI openAPI, MetaClass entityClass)

    • createEntityCreateOperation

      protected io.swagger.v3.oas.models.Operation createEntityCreateOperation(MetaClass entityClass)

    • createEntityBrowseOperation

      protected io.swagger.v3.oas.models.Operation createEntityBrowseOperation(MetaClass entityClass)

    • createEntityReadOperation

      protected io.swagger.v3.oas.models.Operation createEntityReadOperation(MetaClass entityClass)

    • createEntityUpdateOperation

      protected io.swagger.v3.oas.models.Operation createEntityUpdateOperation(MetaClass entityClass)

    • createEntityDeleteOperation

      protected io.swagger.v3.oas.models.Operation createEntityDeleteOperation(MetaClass entityClass)

    • createEntitySearchOperation

      protected io.swagger.v3.oas.models.Operation createEntitySearchOperation(MetaClass entityClass, org.springframework.web.bind.annotation.RequestMethod method)

    • createEntityOptionalParams

      protected List<io.swagger.v3.oas.models.parameters.Parameter> createEntityOptionalParams(boolean singleEntityOperation)

    • getNamePatternProperty

      protected io.swagger.v3.oas.models.media.Schema<?> getNamePatternProperty(MetaClass entityClass)

    • buildServicesPaths

      protected void buildServicesPaths(io.swagger.v3.oas.models.OpenAPI openAPI)

    • createServiceMethodOp

      protected io.swagger.v3.oas.models.Operation createServiceMethodOp(String service, RestServicesConfiguration.RestMethodInfo methodInfo, org.springframework.web.bind.annotation.RequestMethod requestMethod)

    • createServiceMethodParams

      protected List<io.swagger.v3.oas.models.parameters.Parameter> createServiceMethodParams(RestServicesConfiguration.RestMethodInfo methodInfo, org.springframework.web.bind.annotation.RequestMethod requestMethod)

    • createServiceMethodRequestBody

      @Nullable protected io.swagger.v3.oas.models.parameters.RequestBody createServiceMethodRequestBody(RestServicesConfiguration.RestMethodInfo methodInfo, org.springframework.web.bind.annotation.RequestMethod method)

    • buildQueriesPaths

      protected void buildQueriesPaths(io.swagger.v3.oas.models.OpenAPI openAPI)

    • createQueryOperation

      protected io.swagger.v3.oas.models.Operation createQueryOperation(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method)

    • createQueryCountOperation

      protected io.swagger.v3.oas.models.Operation createQueryCountOperation(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method)

    • createQueryOpParams

      protected List<io.swagger.v3.oas.models.parameters.Parameter> createQueryOpParams(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method, boolean generateOptionalParams)

    • createOptionalQueryParams

      protected List<io.swagger.v3.oas.models.parameters.Parameter> createOptionalQueryParams()

    • createQueryRequestBody

      @Nullable protected io.swagger.v3.oas.models.parameters.RequestBody createQueryRequestBody(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method)

    • createGetOperationParam

      protected io.swagger.v3.oas.models.parameters.Parameter createGetOperationParam(String parameterName, String parameterType)

    • getPropertyFromJavaType

      protected io.swagger.v3.oas.models.media.Schema<?> getPropertyFromJavaType(String type)

    • getObjectProperty

      @Nullable protected io.swagger.v3.oas.models.media.Schema<?> getObjectProperty(String classFqn)

    • getPrimitiveProperty

      @Nullable protected io.swagger.v3.oas.models.media.Schema<?> getPrimitiveProperty(String type)

    • createErrorResponse

      protected io.swagger.v3.oas.models.responses.ApiResponse createErrorResponse(String msg)

    • createEntityResponse

      protected io.swagger.v3.oas.models.responses.ApiResponse createEntityResponse(String msg, String entityName)

    • createEntityArrayResponse

      protected io.swagger.v3.oas.models.responses.ApiResponse createEntityArrayResponse(String msg, String entityName)

    • createEntityContent

      protected io.swagger.v3.oas.models.media.Content createEntityContent(String entityName)

    • getEntitySchemaName

      protected String getEntitySchemaName(String entityName)

    • getEntitySchemaRef

      protected String getEntitySchemaRef(String entityName)

    • getErrorSchemaRef

      protected String getErrorSchemaRef()