Reader (swagger-grails4 0.0.2 API)

swagger.grails4.openapi.Reader

All Implemented Interfaces and Traits:

io.swagger.v3.oas.integration.api.OpenApiReader
```
@groovy.util.logging.Slf4j
class Reader
extends java.lang.Object
```
Groovy annotation reader for OpenAPI
Authors:
bo.yang

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Reader.TypeAndFormat`	According to the https://swagger.io/docs/specification/data-models/data-types/

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`DEFAULT_MIME`
`static java.lang.String`	`JSON_MIME`
`grails.core.GrailsApplication`	`application`
`io.swagger.v3.oas.integration.api.OpenAPIConfiguration`	`config`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`io.swagger.v3.oas.models.parameters.RequestBody`	`buildActionCommandParameters(java.lang.String actionName, grails.core.GrailsControllerClass grailsControllerClass)` Grails controller original action has an annotation "Action" with member "commandObjects" store action commands classes, we will build parameter schemas on these command class.
	`java.util.Map<java.lang.String, io.swagger.v3.oas.models.media.Schema>`	`buildClassProperties(java.lang.Class<?> aClass)`
	`io.swagger.v3.oas.models.tags.Tag`	`buildControllerDoc(grails.core.GrailsControllerClass grailsControllerClass)`
	`static void`	`buildEnumDescription(java.lang.Class aClass, io.swagger.v3.oas.models.media.Schema schema)`
	`static java.util.List`	`buildEnumItems(java.lang.Class enumClass)` Use enum id as property value
	`java.lang.Object`	`buildPathItem(io.swagger.v3.oas.models.Operation operation, java.lang.String actionName, grails.core.GrailsControllerClass controllerArtifact, grails.web.mapping.UrlMappingsHolder urlMappingsHolder)`
	`io.swagger.v3.oas.models.media.Schema`	`buildSchema(java.lang.Class aClass, java.lang.reflect.Type genericType = null)` Build Schema from command class or domain class
	`static java.lang.String`	`buildSchemaDescription(java.lang.Class aClass)`
	`static Reader.TypeAndFormat`	`buildType(java.lang.Class aClass)` Build OASv3 type and format from class.
	`static io.swagger.v3.oas.models.media.Schema`	`cloneSchema(io.swagger.v3.oas.models.media.Schema schema)`
	`void`	`cutReferencingCycle(io.swagger.v3.oas.models.media.Schema schema)`
	`static java.lang.String`	`getRef(io.swagger.v3.oas.models.media.Schema schema)`
	`static io.swagger.v3.oas.models.media.Schema`	`getSchemaBy$Ref(io.swagger.v3.oas.models.OpenAPI openAPI, java.lang.String ref)`
	`io.swagger.v3.oas.models.media.Schema`	`getSchemaFromOpenAPI(java.lang.Class aClass, boolean clone = true)` Get a clone schema from openApi
	`static boolean`	`isCommandClass(java.lang.Class<?> aClass)`
	`boolean`	`isCycleReferencing(io.swagger.v3.oas.models.media.Schema schema, java.lang.String targetName = null)` check if schema is in properties referencing cycle
	`java.lang.Object`	`processApiDocAnnotation(java.lang.Class controllerClass)`
	`java.lang.Object`	`processClosure(java.lang.Class closureClass, AnnotationBuilder builder)`
	`io.swagger.v3.oas.models.OpenAPI`	`read(java.util.Set<java.lang.Class<?>> classes, java.util.Map<java.lang.String, java.lang.Object> resources)` Read controller classes, build OpenAPI object.
	`static java.lang.String`	`schemaNameFromClass(java.lang.Class aClass)`
	`void`	`setConfiguration(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final java.lang.String DEFAULT_MIME
  - static final java.lang.String JSON_MIME
  - grails.core.GrailsApplication application
  - io.swagger.v3.oas.integration.api.OpenAPIConfiguration config
- Method Detail
  - @groovy.transform.CompileStatic io.swagger.v3.oas.models.parameters.RequestBody buildActionCommandParameters(java.lang.String actionName, grails.core.GrailsControllerClass grailsControllerClass)
    
    Grails controller original action has an annotation "Action" with member "commandObjects" store action commands classes, we will build parameter schemas on these command class.
    Parameters:
    actionName - name of the action to build
    grailsControllerClass - action belonged grails controller class
  - @groovy.transform.CompileStatic java.util.Map<java.lang.String, io.swagger.v3.oas.models.media.Schema> buildClassProperties(java.lang.Class<?> aClass)
  - @groovy.transform.CompileStatic io.swagger.v3.oas.models.tags.Tag buildControllerDoc(grails.core.GrailsControllerClass grailsControllerClass)
  - static void buildEnumDescription(java.lang.Class aClass, io.swagger.v3.oas.models.media.Schema schema)
  - static java.util.List buildEnumItems(java.lang.Class enumClass)
    
    Use enum id as property value
  - @groovy.transform.CompileStatic java.lang.Object buildPathItem(io.swagger.v3.oas.models.Operation operation, java.lang.String actionName, grails.core.GrailsControllerClass controllerArtifact, grails.web.mapping.UrlMappingsHolder urlMappingsHolder)
  - io.swagger.v3.oas.models.media.Schema buildSchema(java.lang.Class aClass, java.lang.reflect.Type genericType = null)
    
    Build Schema from command class or domain class
    Parameters:
    aClass - command class, domain class
    genericType - the genericType of the aClass, such as a Collection class
    Returns:
    OAS Schema object
  - @groovy.transform.CompileStatic static java.lang.String buildSchemaDescription(java.lang.Class aClass)
  - @groovy.transform.CompileStatic static Reader.TypeAndFormat buildType(java.lang.Class aClass)
    
    Build OASv3 type and format from class.
  - @groovy.transform.CompileStatic static io.swagger.v3.oas.models.media.Schema cloneSchema(io.swagger.v3.oas.models.media.Schema schema)
  - void cutReferencingCycle(io.swagger.v3.oas.models.media.Schema schema)
  - @groovy.transform.CompileStatic static java.lang.String getRef(io.swagger.v3.oas.models.media.Schema schema)
  - static io.swagger.v3.oas.models.media.Schema getSchemaBy$Ref(io.swagger.v3.oas.models.OpenAPI openAPI, java.lang.String ref)
  - @groovy.transform.CompileStatic io.swagger.v3.oas.models.media.Schema getSchemaFromOpenAPI(java.lang.Class aClass, boolean clone = true)
    
    Get a clone schema from openApi
    Parameters:
    aClass - class to find in openApi
    clone - true means clone the schema object if it is found in openApi
    Returns:
    the found schema object or null
  - @groovy.transform.CompileStatic static boolean isCommandClass(java.lang.Class<?> aClass)
  - boolean isCycleReferencing(io.swagger.v3.oas.models.media.Schema schema, java.lang.String targetName = null)
    
    check if schema is in properties referencing cycle
    Parameters:
    schema - Schema or ArraySchema
    Returns:
    true the schema is in the reference cycle
  - @groovy.transform.CompileStatic java.lang.Object processApiDocAnnotation(java.lang.Class controllerClass)
  - java.lang.Object processClosure(java.lang.Class closureClass, AnnotationBuilder builder)
  - @java.lang.Override @groovy.transform.CompileStatic io.swagger.v3.oas.models.OpenAPI read(java.util.Set<java.lang.Class<?>> classes, java.util.Map<java.lang.String, java.lang.Object> resources)
    
    Read controller classes, build OpenAPI object.
    ApiDoc:
    annotation
    
    Parameters:
    classes - controller classes or any classes with
    resources - TODO Understanding what it is
    Returns:
    openAPI object
  - @groovy.transform.CompileStatic static java.lang.String schemaNameFromClass(java.lang.Class aClass)
  - @groovy.transform.CompileStatic @java.lang.Override void setConfiguration(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)

Summary:
Nested
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class Reader

Nested Class Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String DEFAULT_MIME

static final java.lang.String JSON_MIME

grails.core.GrailsApplication application

io.swagger.v3.oas.integration.api.OpenAPIConfiguration config

Method Detail

@groovy.transform.CompileStatic io.swagger.v3.oas.models.parameters.RequestBody buildActionCommandParameters(java.lang.String actionName, grails.core.GrailsControllerClass grailsControllerClass)

@groovy.transform.CompileStatic java.util.Map<java.lang.String, io.swagger.v3.oas.models.media.Schema> buildClassProperties(java.lang.Class<?> aClass)

@groovy.transform.CompileStatic io.swagger.v3.oas.models.tags.Tag buildControllerDoc(grails.core.GrailsControllerClass grailsControllerClass)

static void buildEnumDescription(java.lang.Class aClass, io.swagger.v3.oas.models.media.Schema schema)

static java.util.List buildEnumItems(java.lang.Class enumClass)

@groovy.transform.CompileStatic java.lang.Object buildPathItem(io.swagger.v3.oas.models.Operation operation, java.lang.String actionName, grails.core.GrailsControllerClass controllerArtifact, grails.web.mapping.UrlMappingsHolder urlMappingsHolder)

io.swagger.v3.oas.models.media.Schema buildSchema(java.lang.Class aClass, java.lang.reflect.Type genericType = null)

@groovy.transform.CompileStatic static java.lang.String buildSchemaDescription(java.lang.Class aClass)

@groovy.transform.CompileStatic static Reader.TypeAndFormat buildType(java.lang.Class aClass)

@groovy.transform.CompileStatic static io.swagger.v3.oas.models.media.Schema cloneSchema(io.swagger.v3.oas.models.media.Schema schema)

void cutReferencingCycle(io.swagger.v3.oas.models.media.Schema schema)

@groovy.transform.CompileStatic static java.lang.String getRef(io.swagger.v3.oas.models.media.Schema schema)

static io.swagger.v3.oas.models.media.Schema getSchemaBy$Ref(io.swagger.v3.oas.models.OpenAPI openAPI, java.lang.String ref)

@groovy.transform.CompileStatic io.swagger.v3.oas.models.media.Schema getSchemaFromOpenAPI(java.lang.Class aClass, boolean clone = true)

@groovy.transform.CompileStatic static boolean isCommandClass(java.lang.Class<?> aClass)

boolean isCycleReferencing(io.swagger.v3.oas.models.media.Schema schema, java.lang.String targetName = null)

@groovy.transform.CompileStatic java.lang.Object processApiDocAnnotation(java.lang.Class controllerClass)

java.lang.Object processClosure(java.lang.Class closureClass, AnnotationBuilder builder)

@java.lang.Override @groovy.transform.CompileStatic io.swagger.v3.oas.models.OpenAPI read(java.util.Set<java.lang.Class<?>> classes, java.util.Map<java.lang.String, java.lang.Object> resources)

@groovy.transform.CompileStatic static java.lang.String schemaNameFromClass(java.lang.Class aClass)

@groovy.transform.CompileStatic @java.lang.Override void setConfiguration(io.swagger.v3.oas.integration.api.OpenAPIConfiguration openApiConfiguration)