io.micronaut.openapi.visitor

Class AbstractOpenApiEndpointVisitor<C,E>

java.lang.Object

io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor<C,E>

Type Parameters:

C - The annotation required on the class. Use Object for all classes.

E - The annotation required on the element. Use Object for all elements.

All Implemented Interfaces:

io.micronaut.core.order.Ordered, io.micronaut.inject.visitor.TypeElementVisitor<C,E>

Direct Known Subclasses:

OpenApiControllerVisitor, OpenApiEndpointVisitor

public abstract class AbstractOpenApiEndpointVisitor<C,E>
extends java.lang.Object
implements io.micronaut.inject.visitor.TypeElementVisitor<C,E>

A TypeElementVisitor the builds the Swagger model from Micronaut controllers at compile time.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<io.swagger.v3.oas.models.tags.Tag>	classTags
protected io.micronaut.context.env.PropertyPlaceholderResolver	propertyPlaceholderResolver

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractOpenApiEndpointVisitor()

Method Summary

Modifier and Type	Method and Description
protected io.swagger.v3.oas.models.media.Schema	bindArraySchemaAnnotationValue(io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.Element element, io.swagger.v3.oas.models.media.Schema schemaToBind, io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.media.ArraySchema> schemaAnn) Binds the array schema for the given element.
protected io.swagger.v3.oas.models.media.Schema	bindSchemaAnnotationValue(io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.Element element, io.swagger.v3.oas.models.media.Schema schemaToBind, io.micronaut.core.annotation.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(io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.Element element, io.micronaut.inject.ast.ClassElement elementType, io.swagger.v3.oas.models.media.Schema schemaToBind) Binds the schema for the given element.
protected abstract java.util.List<io.swagger.v3.oas.models.tags.Tag>	classTags(io.micronaut.inject.ast.ClassElement element, io.micronaut.inject.visitor.VisitorContext context) Returns the class tags.
protected abstract java.util.List<io.micronaut.http.MediaType>	consumesMediaTypes(io.micronaut.inject.ast.MethodElement element) Returns the consumes media types.
protected abstract java.lang.String	description(io.micronaut.inject.ast.MethodElement element) Returns the description for the element.
protected abstract io.micronaut.http.HttpMethod	httpMethod(io.micronaut.inject.ast.MethodElement element) Returns the HttpMethod of the element.
protected abstract boolean	ignore(io.micronaut.inject.ast.ClassElement element, io.micronaut.inject.visitor.VisitorContext context) Returns true if the specified element should not be processed.
protected abstract boolean	ignore(io.micronaut.inject.ast.MethodElement element, io.micronaut.inject.visitor.VisitorContext context) Returns true if the specified element should not be processed.
protected io.swagger.v3.oas.models.security.SecurityRequirement	mapToSecurityRequirement(io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.security.SecurityRequirement> r) Maps annotation value to SecurityRequirement.
protected abstract java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement>	methodSecurityRequirements(io.micronaut.inject.ast.MethodElement element, io.micronaut.inject.visitor.VisitorContext context) Returns the security requirements at method level.
protected abstract java.util.List<io.swagger.v3.oas.models.servers.Server>	methodServers(io.micronaut.inject.ast.MethodElement element, io.micronaut.inject.visitor.VisitorContext context) Returns the servers at method level.
protected void	normalizeEnumValues(java.util.Map<java.lang.CharSequence,java.lang.Object> paramValues, java.util.Map<java.lang.String,java.lang.Class<? extends java.lang.Enum>> enumTypes) Normalizes enum values stored in the map.
protected void	processSchemaProperty(io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.Element element, io.micronaut.inject.ast.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(io.micronaut.inject.ast.ClassElement element, io.micronaut.inject.visitor.VisitorContext context) Processes SecurityScheme annotations.
protected abstract java.util.List<io.micronaut.http.MediaType>	producesMediaTypes(io.micronaut.inject.ast.MethodElement element) Returns the produces media types.
protected io.swagger.v3.oas.models.media.Schema	readSchema(io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.media.Schema> schemaValue, io.swagger.v3.oas.models.OpenAPI openAPI, io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.Element type, java.util.List<io.micronaut.http.MediaType> mediaTypes) Reads schema.
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.micronaut.inject.ast.Element definingElement, io.micronaut.inject.ast.ClassElement type, io.micronaut.inject.visitor.VisitorContext context, java.util.List<io.micronaut.http.MediaType> mediaTypes) Resolves the schema for the given type element.
protected io.swagger.v3.oas.models.media.Schema	resolveSchema(io.swagger.v3.oas.models.OpenAPI openAPI, io.micronaut.inject.ast.Element definingElement, io.micronaut.inject.ast.ClassElement type, io.micronaut.inject.visitor.VisitorContext context, java.util.List<io.micronaut.http.MediaType> mediaTypes) Resolves the schema for the given type element.
protected java.util.Map<java.lang.CharSequence,java.lang.Object>	toValueMap(java.util.Map<java.lang.CharSequence,java.lang.Object> values, io.micronaut.inject.visitor.VisitorContext context) Convert the values to a map.
protected <T> T	treeToValue(com.fasterxml.jackson.databind.JsonNode jn, java.lang.Class<T> clazz) Converts Json node into a class' instance or throws 'com.fasterxml.jackson.core.JsonProcessingException', adds extensions if present.
protected abstract java.util.List<io.micronaut.http.uri.UriMatchTemplate>	uriMatchTemplates(io.micronaut.inject.ast.MethodElement element) Returns the uri paths of the element.
void	visitClass(io.micronaut.inject.ast.ClassElement element, io.micronaut.inject.visitor.VisitorContext context)
void	visitMethod(io.micronaut.inject.ast.MethodElement element, io.micronaut.inject.visitor.VisitorContext context)

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

finish, start, visitConstructor, visitField

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

getOrder

Field Detail

classTags

protected java.util.List<io.swagger.v3.oas.models.tags.Tag> classTags

propertyPlaceholderResolver

protected io.micronaut.context.env.PropertyPlaceholderResolver propertyPlaceholderResolver

Constructor Detail

AbstractOpenApiEndpointVisitor

public AbstractOpenApiEndpointVisitor()

Method Detail

visitClass

public void visitClass(io.micronaut.inject.ast.ClassElement element,
                       io.micronaut.inject.visitor.VisitorContext context)

Specified by:

visitClass in interface io.micronaut.inject.visitor.TypeElementVisitor<C,E>

methodSecurityRequirements

protected abstract java.util.List<io.swagger.v3.oas.models.security.SecurityRequirement> methodSecurityRequirements(io.micronaut.inject.ast.MethodElement element,
                                                                                                                    io.micronaut.inject.visitor.VisitorContext context)

Returns the security requirements at method level.

Parameters:

element - The MethodElement.

context - The context.

Returns:

The security requirements.

methodServers

protected abstract java.util.List<io.swagger.v3.oas.models.servers.Server> methodServers(io.micronaut.inject.ast.MethodElement element,
                                                                                         io.micronaut.inject.visitor.VisitorContext context)

Returns the servers at method level.

Parameters:

element - The MethodElement.

context - The context.

Returns:

The servers.

classTags

protected abstract java.util.List<io.swagger.v3.oas.models.tags.Tag> classTags(io.micronaut.inject.ast.ClassElement element,
                                                                               io.micronaut.inject.visitor.VisitorContext context)

Returns the class tags.

Parameters:

element - The ClassElement.

context - The context.

Returns:

The class tags.

ignore

protected abstract boolean ignore(io.micronaut.inject.ast.ClassElement element,
                                  io.micronaut.inject.visitor.VisitorContext context)

Returns true if the specified element should not be processed.

Parameters:

element - The ClassElement.

context - The context.

Returns:

true if the specified element should not be processed.

ignore

protected abstract boolean ignore(io.micronaut.inject.ast.MethodElement element,
                                  io.micronaut.inject.visitor.VisitorContext context)

Returns true if the specified element should not be processed.

Parameters:

element - The ClassElement.

context - The context.

Returns:

true if the specified element should not be processed.

httpMethod

protected abstract io.micronaut.http.HttpMethod httpMethod(io.micronaut.inject.ast.MethodElement element)

Returns the HttpMethod of the element.

Parameters:

element - The MethodElement.

Returns:

The HttpMethod of the element.

uriMatchTemplates

protected abstract java.util.List<io.micronaut.http.uri.UriMatchTemplate> uriMatchTemplates(io.micronaut.inject.ast.MethodElement element)

Returns the uri paths of the element.

Parameters:

element - The MethodElement.

Returns:

The uri paths of the element.

consumesMediaTypes

protected abstract java.util.List<io.micronaut.http.MediaType> consumesMediaTypes(io.micronaut.inject.ast.MethodElement element)

Returns the consumes media types.

Parameters:

element - The MethodElement.

Returns:

The consumes media types.

producesMediaTypes

protected abstract java.util.List<io.micronaut.http.MediaType> producesMediaTypes(io.micronaut.inject.ast.MethodElement element)

Returns the produces media types.

Parameters:

element - The MethodElement.

Returns:

The produces media types.

description

protected abstract java.lang.String description(io.micronaut.inject.ast.MethodElement element)

Returns the description for the element.

Parameters:

element - The MethodElement.

Returns:

The description for the element.

visitMethod

public void visitMethod(io.micronaut.inject.ast.MethodElement element,
                        io.micronaut.inject.visitor.VisitorContext context)

Specified by:

visitMethod in interface io.micronaut.inject.visitor.TypeElementVisitor<C,E>

treeToValue

protected <T> T treeToValue(com.fasterxml.jackson.databind.JsonNode jn,
                            java.lang.Class<T> clazz)
                     throws com.fasterxml.jackson.core.JsonProcessingException

Converts Json node into a class' instance or throws 'com.fasterxml.jackson.core.JsonProcessingException', adds extensions if present.

Type Parameters:

T - The output class type

Parameters:

jn - The json node

clazz - The output class instance

Returns:

The converted instance

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if error

toValueMap

protected java.util.Map<java.lang.CharSequence,java.lang.Object> toValueMap(java.util.Map<java.lang.CharSequence,java.lang.Object> values,
                                                                            io.micronaut.inject.visitor.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(@Nullable
                                                                        io.micronaut.inject.ast.Element definingElement,
                                                                        io.micronaut.inject.ast.ClassElement type,
                                                                        io.micronaut.inject.visitor.VisitorContext context,
                                                                        java.util.List<io.micronaut.http.MediaType> mediaTypes)

Resolves the schema for the given type element.

Parameters:

definingElement - The defining element

type - The type element

context - The context

mediaTypes - An optional media type

Returns:

The schema or null if it cannot be resolved

resolveSchema

@Nullable
protected io.swagger.v3.oas.models.media.Schema resolveSchema(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                        @Nullable
                                                                        io.micronaut.inject.ast.Element definingElement,
                                                                        io.micronaut.inject.ast.ClassElement type,
                                                                        io.micronaut.inject.visitor.VisitorContext context,
                                                                        java.util.List<io.micronaut.http.MediaType> mediaTypes)

Resolves the schema for the given type element.

Parameters:

openAPI - The OpenAPI object

definingElement - The defining element

type - The type element

context - The context

mediaTypes - 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(io.micronaut.inject.visitor.VisitorContext context,
                                     io.micronaut.inject.ast.Element element,
                                     io.micronaut.inject.ast.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 element type

parentSchema - The parent schema

propertySchema - The property schema

bindSchemaForElement

protected io.swagger.v3.oas.models.media.Schema bindSchemaForElement(io.micronaut.inject.visitor.VisitorContext context,
                                                                     io.micronaut.inject.ast.Element element,
                                                                     io.micronaut.inject.ast.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(io.micronaut.inject.visitor.VisitorContext context,
                                                                          io.micronaut.inject.ast.Element element,
                                                                          io.swagger.v3.oas.models.media.Schema schemaToBind,
                                                                          io.micronaut.core.annotation.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

bindArraySchemaAnnotationValue

protected io.swagger.v3.oas.models.media.Schema bindArraySchemaAnnotationValue(io.micronaut.inject.visitor.VisitorContext context,
                                                                               io.micronaut.inject.ast.Element element,
                                                                               io.swagger.v3.oas.models.media.Schema schemaToBind,
                                                                               io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.media.ArraySchema> schemaAnn)

Binds the array 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

readSchema

protected io.swagger.v3.oas.models.media.Schema readSchema(io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.media.Schema> schemaValue,
                                                           io.swagger.v3.oas.models.OpenAPI openAPI,
                                                           io.micronaut.inject.visitor.VisitorContext context,
                                                           @Nullable
                                                           io.micronaut.inject.ast.Element type,
                                                           java.util.List<io.micronaut.http.MediaType> mediaTypes)
                                                    throws com.fasterxml.jackson.core.JsonProcessingException

Reads schema.

Parameters:

schemaValue - annotation value

openAPI - The OpenApi

context - The VisitorContext

type - The element

mediaTypes - The media types of schema

Returns:

New schema instance

Throws:

com.fasterxml.jackson.core.JsonProcessingException - when Json parsing fails

processSecuritySchemes

protected void processSecuritySchemes(io.micronaut.inject.ast.ClassElement element,
                                      io.micronaut.inject.visitor.VisitorContext context)

Processes SecurityScheme annotations.

Parameters:

element - The element

context - The visitor context

normalizeEnumValues

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

Normalizes enum values stored in the map.

Parameters:

paramValues - The values

enumTypes - The enum types.

mapToSecurityRequirement

protected io.swagger.v3.oas.models.security.SecurityRequirement mapToSecurityRequirement(io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.security.SecurityRequirement> r)

Maps annotation value to SecurityRequirement. Correct format is: custom_name: - custom_scope1 - custom_scope2

Parameters:

r - The value of SecurityRequirement.

Returns:

converted object.