io.jmix.rest.impl.openapi

Class OpenAPIGeneratorImpl

java.lang.Object

io.jmix.rest.impl.openapi.OpenAPIGeneratorImpl

All Implemented Interfaces:

OpenAPIGenerator

@Component(value="rest_OpenAPIGenerator")
public class OpenAPIGeneratorImpl
extends java.lang.Object
implements OpenAPIGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ARRAY_SIGNATURE
protected io.jmix.core.CoreProperties	coreProperties
protected static java.lang.String	ENTITY_PATH
protected static java.lang.String	ENTITY_RUD_OPS
protected static java.lang.String	ENTITY_SEARCH
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
protected io.swagger.v3.oas.models.OpenAPI	openAPI
protected RestQueriesConfiguration	queriesConfiguration
protected static java.lang.String	QUERY_COUNT_PATH
protected static java.lang.String	QUERY_PATH
protected io.jmix.core.Resources	resources
protected static java.lang.String	SCHEMAS_PREFIX
protected static java.lang.String	SERVICE_PATH
protected RestServicesConfiguration	servicesConfiguration
protected javax.servlet.ServletContext	servletContext

Constructor Summary

Constructors

Constructor and Description
OpenAPIGeneratorImpl()

Method Summary

Modifier and Type	Method and Description
protected void	buildEntitiesPaths(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void	buildEntityFilterPaths(io.swagger.v3.oas.models.OpenAPI openAPI, io.jmix.core.metamodel.model.MetaClass entityClass)
protected void	buildEntityPath(io.swagger.v3.oas.models.OpenAPI openAPI, io.jmix.core.metamodel.model.MetaClass entityClass)
protected void	buildEntityRUDPaths(io.swagger.v3.oas.models.OpenAPI openAPI, io.jmix.core.metamodel.model.MetaClass entityClass)
protected void	buildEntitySchema(io.swagger.v3.oas.models.OpenAPI openAPI, io.jmix.core.metamodel.model.MetaClass entityClass)
protected void	buildErrorSchema(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void	buildInfo(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void	buildQueriesPaths(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void	buildServer(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void	buildServicesPaths(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void	buildTags(io.swagger.v3.oas.models.OpenAPI openAPI)
protected void	checkInitialized()
protected io.swagger.v3.oas.models.responses.ApiResponse	createEntityArrayResponse(java.lang.String msg, java.lang.String entityName)
protected io.swagger.v3.oas.models.Operation	createEntityBrowseOperation(io.jmix.core.metamodel.model.MetaClass entityClass)
protected io.swagger.v3.oas.models.media.Content	createEntityContent(java.lang.String entityName)
protected io.swagger.v3.oas.models.Operation	createEntityCreateOperation(io.jmix.core.metamodel.model.MetaClass entityClass)
protected io.swagger.v3.oas.models.Operation	createEntityDeleteOperation(io.jmix.core.metamodel.model.MetaClass entityClass)
protected java.util.List<io.swagger.v3.oas.models.parameters.Parameter>	createEntityOptionalParams(boolean singleEntityOperation)
protected io.swagger.v3.oas.models.Operation	createEntityReadOperation(io.jmix.core.metamodel.model.MetaClass entityClass)
protected io.swagger.v3.oas.models.responses.ApiResponse	createEntityResponse(java.lang.String msg, java.lang.String entityName)
protected io.swagger.v3.oas.models.Operation	createEntitySearchOperation(io.jmix.core.metamodel.model.MetaClass entityClass, org.springframework.web.bind.annotation.RequestMethod method)
protected io.swagger.v3.oas.models.Operation	createEntityUpdateOperation(io.jmix.core.metamodel.model.MetaClass entityClass)
protected io.swagger.v3.oas.models.responses.ApiResponse	createErrorResponse(java.lang.String msg)
protected io.swagger.v3.oas.models.parameters.Parameter	createGetOperationParam(java.lang.String parameterName, java.lang.String parameterType)
protected java.util.List<io.swagger.v3.oas.models.parameters.Parameter>	createOptionalQueryParams()
protected io.swagger.v3.oas.models.Operation	createQueryCountOperation(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method)
protected io.swagger.v3.oas.models.Operation	createQueryOperation(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method)
protected java.util.List<io.swagger.v3.oas.models.parameters.Parameter>	createQueryOpParams(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method, boolean generateOptionalParams)
protected io.swagger.v3.oas.models.parameters.RequestBody	createQueryRequestBody(RestQueriesConfiguration.QueryInfo query, org.springframework.web.bind.annotation.RequestMethod method)
protected io.swagger.v3.oas.models.Operation	createServiceMethodOp(java.lang.String service, RestServicesConfiguration.RestMethodInfo methodInfo, org.springframework.web.bind.annotation.RequestMethod requestMethod)
protected java.util.List<io.swagger.v3.oas.models.parameters.Parameter>	createServiceMethodParams(RestServicesConfiguration.RestMethodInfo methodInfo, org.springframework.web.bind.annotation.RequestMethod requestMethod)
protected io.swagger.v3.oas.models.parameters.RequestBody	createServiceMethodRequestBody(RestServicesConfiguration.RestMethodInfo methodInfo, org.springframework.web.bind.annotation.RequestMethod method)
io.swagger.v3.oas.models.OpenAPI	generateOpenAPI()
protected java.lang.String	getEntitySchemaName(java.lang.String entityName)
protected java.lang.String	getEntitySchemaRef(java.lang.String entityName)
protected java.lang.String	getErrorSchemaRef()
protected io.swagger.v3.oas.models.media.Schema<?>	getNamePatternProperty(io.jmix.core.metamodel.model.MetaClass entityClass)
protected io.swagger.v3.oas.models.media.Schema<?>	getObjectProperty(java.lang.String classFqn)
protected io.swagger.v3.oas.models.media.Schema<?>	getPrimitiveProperty(java.lang.String type)
protected io.swagger.v3.oas.models.media.Schema<?>	getPropertyFromJavaType(java.lang.String type)
protected void	init()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTITY_PATH

protected static final java.lang.String ENTITY_PATH

See Also:

Constant Field Values

ENTITY_RUD_OPS

protected static final java.lang.String ENTITY_RUD_OPS

See Also:

Constant Field Values

ENTITY_SEARCH

protected static final java.lang.String ENTITY_SEARCH

See Also:

Constant Field Values

QUERY_PATH

protected static final java.lang.String QUERY_PATH

See Also:

Constant Field Values

QUERY_COUNT_PATH

protected static final java.lang.String QUERY_COUNT_PATH

See Also:

Constant Field Values

SERVICE_PATH

protected static final java.lang.String SERVICE_PATH

See Also:

Constant Field Values

SCHEMAS_PREFIX

protected static final java.lang.String SCHEMAS_PREFIX

See Also:

Constant Field Values

ARRAY_SIGNATURE

protected static final java.lang.String ARRAY_SIGNATURE

See Also:

Constant Field Values

coreProperties

@Autowired
protected io.jmix.core.CoreProperties coreProperties

servletContext

@Autowired(required=false)
protected javax.servlet.ServletContext servletContext

resources

@Autowired
protected io.jmix.core.Resources resources

metadata

@Autowired
protected io.jmix.core.Metadata metadata

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

queriesConfiguration

@Autowired
protected RestQueriesConfiguration queriesConfiguration

servicesConfiguration

@Autowired
protected RestServicesConfiguration servicesConfiguration

openAPI

protected io.swagger.v3.oas.models.OpenAPI openAPI

Constructor Detail

OpenAPIGeneratorImpl

public OpenAPIGeneratorImpl()

Method Detail

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()

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,
                                 io.jmix.core.metamodel.model.MetaClass entityClass)

buildEntityPath

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

buildEntityRUDPaths

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

buildEntityFilterPaths

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

createEntityCreateOperation

protected io.swagger.v3.oas.models.Operation createEntityCreateOperation(io.jmix.core.metamodel.model.MetaClass entityClass)

createEntityBrowseOperation

protected io.swagger.v3.oas.models.Operation createEntityBrowseOperation(io.jmix.core.metamodel.model.MetaClass entityClass)

createEntityReadOperation

protected io.swagger.v3.oas.models.Operation createEntityReadOperation(io.jmix.core.metamodel.model.MetaClass entityClass)

createEntityUpdateOperation

protected io.swagger.v3.oas.models.Operation createEntityUpdateOperation(io.jmix.core.metamodel.model.MetaClass entityClass)

createEntityDeleteOperation

protected io.swagger.v3.oas.models.Operation createEntityDeleteOperation(io.jmix.core.metamodel.model.MetaClass entityClass)

createEntitySearchOperation

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

createEntityOptionalParams

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

getNamePatternProperty

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

buildServicesPaths

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

createServiceMethodOp

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

createServiceMethodParams

protected java.util.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 java.util.List<io.swagger.v3.oas.models.parameters.Parameter> createQueryOpParams(RestQueriesConfiguration.QueryInfo query,
                                                                                            org.springframework.web.bind.annotation.RequestMethod method,
                                                                                            boolean generateOptionalParams)

createOptionalQueryParams

protected java.util.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(java.lang.String parameterName,
                                                                                java.lang.String parameterType)

getPropertyFromJavaType

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

getObjectProperty

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

getPrimitiveProperty

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

createErrorResponse

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

createEntityResponse

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

createEntityArrayResponse

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

createEntityContent

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

getEntitySchemaName

protected java.lang.String getEntitySchemaName(java.lang.String entityName)

getEntitySchemaRef

protected java.lang.String getEntitySchemaRef(java.lang.String entityName)

getErrorSchemaRef

protected java.lang.String getErrorSchemaRef()