io.micronaut.openapi.visitor

Class OpenApiApplicationVisitor

java.lang.Object

io.micronaut.openapi.visitor.OpenApiApplicationVisitor

All Implemented Interfaces:

Ordered, TypeElementVisitor<io.swagger.v3.oas.annotations.OpenAPIDefinition,Object>

public class OpenApiApplicationVisitor
extends Object
implements TypeElementVisitor<io.swagger.v3.oas.annotations.OpenAPIDefinition,Object>

Visits the application class.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	MICRONAUT_OPENAPI_TARGET_FILE System property that enables setting the target file to write to.

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
OpenApiApplicationVisitor()

Method Summary

Modifier and Type	Method and Description
protected io.swagger.v3.oas.models.media.Schema	bindSchemaAnnotationValue(VisitorContext context, Element element, io.swagger.v3.oas.models.media.Schema schemaToBind, AnnotationValue<io.swagger.v3.oas.annotations.media.Schema> schemaAnn) Binds the schema for the given element.
protected io.swagger.v3.oas.models.media.Schema	bindSchemaForElement(VisitorContext context, Element element, ClassElement elementType, io.swagger.v3.oas.models.media.Schema schemaToBind) Binds the schema for the given element.
void	finish(VisitorContext visitorContext) Called once when visitor processing finishes.
protected void	normalizeEnumValues(Map<CharSequence,Object> paramValues, Map<String,Class<? extends Enum>> enumTypes) Normalizes enum values stored in the map.
protected void	processSchemaProperty(VisitorContext context, Element element, ClassElement elementType, io.swagger.v3.oas.models.media.Schema parentSchema, io.swagger.v3.oas.models.media.Schema propertySchema) Processes a schema property.
protected void	processSecuritySchemes(ClassElement element, VisitorContext context) Processes SecurityScheme annotations.
protected io.swagger.v3.oas.models.Components	resolveComponents(io.swagger.v3.oas.models.OpenAPI openAPI) Resolve the components.
protected io.swagger.v3.oas.models.media.Schema	resolveSchema(io.swagger.v3.oas.models.OpenAPI openAPI, Element definingElement, ClassElement type, VisitorContext context, String mediaType) Resolves the schema for the given type element.
protected Map<CharSequence,Object>	toValueMap(Map<CharSequence,Object> values, VisitorContext context) Convert the values to a map.
void	visitClass(ClassElement element, VisitorContext context) Executed when a class is encountered that matches the generic.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

start, visitConstructor, visitField, visitMethod

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Detail

MICRONAUT_OPENAPI_TARGET_FILE

public static final String MICRONAUT_OPENAPI_TARGET_FILE

System property that enables setting the target file to write to.

See Also:

Constant Field Values

Constructor Detail

OpenApiApplicationVisitor

public OpenApiApplicationVisitor()

Method Detail

visitClass

public void visitClass(ClassElement element,
                       VisitorContext context)

Description copied from interface: TypeElementVisitor

Executed when a class is encountered that matches the generic.

Specified by:

visitClass in interface TypeElementVisitor<io.swagger.v3.oas.annotations.OpenAPIDefinition,Object>

Parameters:

element - The element

context - The visitor context

finish

public void finish(VisitorContext visitorContext)

Description copied from interface: TypeElementVisitor

Called once when visitor processing finishes.

Specified by:

finish in interface TypeElementVisitor<io.swagger.v3.oas.annotations.OpenAPIDefinition,Object>

Parameters:

visitorContext - The visitor context

toValueMap

protected Map<CharSequence,Object> toValueMap(Map<CharSequence,Object> values,
                                              VisitorContext context)

Convert the values to a map.

Parameters:

values - The values

context - The visitor context

Returns:

The map

resolveSchema

@Nullable
protected io.swagger.v3.oas.models.media.Schema resolveSchema(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                        @Nullable
                                                                        Element definingElement,
                                                                        ClassElement type,
                                                                        VisitorContext context,
                                                                        @Nullable
                                                                        String mediaType)

Resolves the schema for the given type element.

Parameters:

openAPI - The OpenAPI object

definingElement - The defining element

type - The type element

context - The context

mediaType - An optional media type

Returns:

The schema or null if it cannot be resolved

resolveComponents

protected io.swagger.v3.oas.models.Components resolveComponents(io.swagger.v3.oas.models.OpenAPI openAPI)

Resolve the components.

Parameters:

openAPI - The open API

Returns:

The components

processSchemaProperty

protected void processSchemaProperty(VisitorContext context,
                                     Element element,
                                     ClassElement elementType,
                                     io.swagger.v3.oas.models.media.Schema parentSchema,
                                     io.swagger.v3.oas.models.media.Schema propertySchema)

Processes a schema property.

Parameters:

context - The visitor context

element - The element

elementType - The elemen type

parentSchema - The parent schema

propertySchema - The property schema

bindSchemaForElement

protected io.swagger.v3.oas.models.media.Schema bindSchemaForElement(VisitorContext context,
                                                                     Element element,
                                                                     ClassElement elementType,
                                                                     io.swagger.v3.oas.models.media.Schema schemaToBind)

Binds the schema for the given element.

Parameters:

context - The context

element - The element

elementType - The element type

schemaToBind - The schema to bind

Returns:

The bound schema

bindSchemaAnnotationValue

protected io.swagger.v3.oas.models.media.Schema bindSchemaAnnotationValue(VisitorContext context,
                                                                          Element element,
                                                                          io.swagger.v3.oas.models.media.Schema schemaToBind,
                                                                          AnnotationValue<io.swagger.v3.oas.annotations.media.Schema> schemaAnn)

Binds the schema for the given element.

Parameters:

context - The context

element - The element

schemaToBind - The schema to bind

schemaAnn - The schema annotation

Returns:

The bound schema

processSecuritySchemes

protected void processSecuritySchemes(ClassElement element,
                                      VisitorContext context)

Processes SecurityScheme annotations.

Parameters:

element - The element

context - The visitor context

normalizeEnumValues

protected void normalizeEnumValues(Map<CharSequence,Object> paramValues,
                                   Map<String,Class<? extends Enum>> enumTypes)

Normalizes enum values stored in the map.

Parameters:

paramValues - The values

enumTypes - The enum types.