A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addApiDocCommentAnnotation(FieldNode, String) - Method in ApiDocTransformer

AnnotationBuilder - Trait in swagger.grails4.openapi.builder

Provide some utility methods for annotation closure builders.

ApiDoc - Annotation Type in swagger.grails4.openapi

The OpenAPI annotation in Groovy Closure style.

ApiDocComment - Annotation Type in swagger.grails4.openapi

ApiDocTransformer - Class in swagger.grails4.compiler

Extract fields comments to

ApiDocComment:

annotations.

Application - Class in swagger.grails4

B

BootStrap - Class in swagger.grails4

buildActionCommandParameters(String, GrailsControllerClass) - Method in Reader

Grails controller original action has an annotation "Action" with member "commandObjects" store action commands classes, we will build parameter schemas on these command class.

buildClassProperties(Class<?>) - Method in Reader

buildControllerDoc(GrailsControllerClass) - Method in Reader

buildEnumDescription(Class, Schema) - Method in Reader

buildEnumItems(Class) - Method in Reader

Use enum id as property value

buildPathItem(Operation, String, GrailsControllerClass, UrlMappingsHolder) - Method in Reader

buildSchema(Class, Type) - Method in Reader

Build Schema from command class or domain class

buildSchema(Object) - Method in SchemaBuilder

Build Schema object from class or closure, if it exists already then clone one with $ref value set.

buildSchemaDescription(Class) - Method in Reader

buildType(Class) - Method in Reader

Build OASv3 type and format from class.

C

classes() - Method in GrailsScanner

cleanComment(String) - Method in ApiDocTransformer

remove /**, *, */, // , comment marks and leading blanks.

cloneSchema(Schema) - Method in Reader

configOpenApi() - Method in OpenApiService

Create an OpenAPI object with configured ahead.

content(Map<String, Closure>) - Method in ResponseBuilder

Build Content object like "content 'application/json': {

cutReferencingCycle(Schema) - Method in Reader

D

document() - Method in OpenApiController

doWithApplicationContext() - Method in SwaggerGrails4GrailsPlugin

doWithDynamicMethods() - Method in SwaggerGrails4GrailsPlugin

doWithSpring() - Method in SwaggerGrails4GrailsPlugin

E

evaluateClosure(Closure, AnnotationBuilder<M>) - Method in AnnotationBuilder

Evaluate closure by delegating to builder and return the production model.

extractComment(SourceUnit, LineColumn, LineColumn) - Method in ApiDocTransformer

extractCommentLiterally(SourceUnit, LineColumn) - Method in ApiDocTransformer

Extract comments from endLineColumn position upwards to the begins, stop when hit "{" or "}" not in comment blocks.

F

findPrevEndOfNode(FieldNode) - Method in ApiDocTransformer

G

generateDocument() - Method in OpenApiService

生成 OpenAPI 文档对象

getRef(Schema) - Method in Reader

getSchemaBy$Ref(OpenAPI, String) - Method in Reader

getSchemaFromOpenAPI(Class, boolean) - Method in Reader

Get a clone schema from openApi

GrailsScanner - Class in swagger.grails4.openapi

Scanner for grails controllers

H

I

index() - Method in OpenApiController

Redirect to /static/api/doc.html

initAnnotationPrimitiveElements() - Method in AnnotationBuilder

initClassPrimitiveProperties() - Method in AnnotationBuilder

initPrimitiveElements() - Method in AnnotationBuilder

Extract properties from OpenAPI annotation

inType(String) - Method in ParameterBuilder

isCommandClass(Class<?>) - Method in Reader

isCycleReferencing(Schema, String) - Method in Reader

check if schema is in properties referencing cycle

isPrimitiveElement(def) - Method in AnnotationBuilder

J

K

L

M

main(String) - Method in Application

MediaTypeBuilder - Class in swagger.grails4.openapi.builder

methodMissing(String, Object) - Method in AnnotationBuilder

For string and string[] annotation attributes we will assign the value to model property.

N

O

onChange(Map<String, Object>) - Method in SwaggerGrails4GrailsPlugin

onConfigChange(Map<String, Object>) - Method in SwaggerGrails4GrailsPlugin

onShutdown(Map<String, Object>) - Method in SwaggerGrails4GrailsPlugin

OpenApiConfig - Annotation Type in swagger.grails4.openapi

The global configuration for OpenAPI document

OpenApiController - Class in swagger.grails4

openAPIDefinition() - Method in ApiDoc

To populate OpenAPI Object fields info, tags, servers, security and externalDocs.

OpenApiService - Class in swagger.grails4

生成 OpenAPI 文档json的服务

operation() - Method in ApiDoc

open api document closure of action.

OperationBuilder - Class in swagger.grails4.openapi.builder

Operation model builder.

OperationBuilder() - Constructor in OperationBuilder

P

ParameterBuilder - Class in swagger.grails4.openapi.builder

ParameterBuilder() - Constructor in ParameterBuilder

parameters(List<Closure>) - Method in OperationBuilder

The "parameters" member of @ApiDoc.

populateSourceBuffer(SourceUnit) - Method in ApiDocTransformer

processApiDocAnnotation(Class) - Method in Reader

processClosure(Class, AnnotationBuilder) - Method in Reader

properties(Map<String, Closure>) - Method in SchemaBuilder

Q

R

read(Set<Class<?>>, Map<String, Object>) - Method in Reader

Read controller classes, build OpenAPI object.

Reader - Class in swagger.grails4.openapi

Groovy annotation reader for OpenAPI

Reader.TypeAndFormat - Class in swagger.grails4.openapi

According to the https://swagger.io/docs/specification/data-models/data-types/

resources() - Method in GrailsScanner

ResponseBuilder - Class in swagger.grails4.openapi.builder

Build Response object of OASv3.

ResponseBuilder() - Constructor in ResponseBuilder

responses(Map<String, Closure>) - Method in OperationBuilder

RestApiResponse - Class in swagger.grails4

A test rest api response class

S

schema(def, Map) - Method in MediaTypeBuilder

for call in "schema classOrClosure, [properties: {...}]" form

SchemaBuilder - Class in swagger.grails4.openapi.builder

schemaNameFromClass(Class) - Method in Reader

securityScheme() - Method in ApiDoc

document closure for security.

setConfiguration(OpenAPIConfiguration) - Method in GrailsScanner

setConfiguration(OpenAPIConfiguration) - Method in Reader

SwaggerGrails4GrailsPlugin - Class in swagger.grails4

Swagger Grails4 plugin

T

tag() - Method in ApiDoc

The annotation may be applied at class or method level, or in io.swagger.v3.oas.annotations.Operation#tags() to define tags for the single operation (when applied at method level) or for all operations of a class (when applied at class level).

TagBuilder - Class in swagger.grails4.openapi.builder

TagBuilder() - Constructor in TagBuilder

U

UrlMappings - Class in swagger.grails4

Url mapping config of grails

V

value() - Method in ApiDoc

place-holder for any place that need a string content.

value() - Method in ApiDocComment

@default ""

value() - Method in OpenApiConfig

The global OpenAPI config closure, it can only be add in one class for one application.

visit(ASTNode, SourceUnit) - Method in ApiDocTransformer

W

X

Y

Z

_