io.micronaut.openapi.visitor

Class OpenApiApplicationVisitor

java.lang.Object

io.micronaut.openapi.visitor.OpenApiApplicationVisitor

All Implemented Interfaces:

io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable, io.micronaut.inject.visitor.TypeElementVisitor<io.swagger.v3.oas.annotations.OpenAPIDefinition,java.lang.Object>

@SupportedOptions(value={"micronaut.openapi.server.context.path","micronaut.openapi.property.naming.strategy","micronaut.openapi.views.spec","micronaut.openapi.target.file","micronaut.openapi.additional.files","micronaut.openapi.config.file"})
public class OpenApiApplicationVisitor
extends java.lang.Object
implements io.micronaut.inject.visitor.TypeElementVisitor<io.swagger.v3.oas.annotations.OpenAPIDefinition,java.lang.Object>

Visits the application class.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

io.micronaut.inject.visitor.TypeElementVisitor.VisitorKind

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MICRONAUT_OPENAPI_ADDITIONAL_FILES System property that specifies the location of additional swagger YAML files to read from.
static java.lang.String	MICRONAUT_OPENAPI_CONFIG_FILE System property that enables setting the open api config file.
static java.lang.String	MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH System property for server context path.
static java.lang.String	MICRONAUT_OPENAPI_ENDPOINT_CLASS_TAGS The name of the entry for Endpoint class tags in the context.
static java.lang.String	MICRONAUT_OPENAPI_ENDPOINT_SECURITY_REQUIREMENTS The name of the entry for Endpoint security requirements in the context.
static java.lang.String	MICRONAUT_OPENAPI_ENDPOINT_SERVERS The name of the entry for Endpoint servers in the context.
static java.lang.String	MICRONAUT_OPENAPI_EXPAND_PREFIX Prefix for expandable properties.
static java.lang.String	MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY System property for naming strategy.
static java.lang.String	MICRONAUT_OPENAPI_TARGET_FILE System property that enables setting the target file to write to.
static java.lang.String	MICRONAUT_OPENAPI_VIEWS_SPEC System property for views specification.
static java.lang.String	OPENAPI_CONFIG_FILE Default openapi config file.

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	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.
void	finish(io.micronaut.inject.visitor.VisitorContext visitorContext)
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 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.micronaut.inject.ast.Element classElement, 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 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.
void	visitClass(io.micronaut.inject.ast.ClassElement 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

getClassType, getElementType, getSupportedAnnotationNames, getSupportedOptions, getVisitorKind, start, visitConstructor, visitField, visitMethod

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

getOrder

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Field Detail

MICRONAUT_OPENAPI_CONFIG_FILE

public static final java.lang.String MICRONAUT_OPENAPI_CONFIG_FILE

System property that enables setting the open api config file.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_EXPAND_PREFIX

public static final java.lang.String MICRONAUT_OPENAPI_EXPAND_PREFIX

Prefix for expandable properties.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH

public static final java.lang.String MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH

System property for server context path.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY

public static final java.lang.String MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY

System property for naming strategy. One jackson PropertyNamingStrategy.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_VIEWS_SPEC

public static final java.lang.String MICRONAUT_OPENAPI_VIEWS_SPEC

System property for views specification.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_TARGET_FILE

public static final java.lang.String MICRONAUT_OPENAPI_TARGET_FILE

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

See Also:

Constant Field Values

MICRONAUT_OPENAPI_ADDITIONAL_FILES

public static final java.lang.String MICRONAUT_OPENAPI_ADDITIONAL_FILES

System property that specifies the location of additional swagger YAML files to read from.

See Also:

Constant Field Values

OPENAPI_CONFIG_FILE

public static final java.lang.String OPENAPI_CONFIG_FILE

Default openapi config file.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_ENDPOINT_CLASS_TAGS

public static final java.lang.String MICRONAUT_OPENAPI_ENDPOINT_CLASS_TAGS

The name of the entry for Endpoint class tags in the context.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_ENDPOINT_SERVERS

public static final java.lang.String MICRONAUT_OPENAPI_ENDPOINT_SERVERS

The name of the entry for Endpoint servers in the context.

See Also:

Constant Field Values

MICRONAUT_OPENAPI_ENDPOINT_SECURITY_REQUIREMENTS

public static final java.lang.String MICRONAUT_OPENAPI_ENDPOINT_SECURITY_REQUIREMENTS

The name of the entry for Endpoint security requirements in the context.

See Also:

Constant Field Values

Constructor Detail

OpenApiApplicationVisitor

public OpenApiApplicationVisitor()

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<io.swagger.v3.oas.annotations.OpenAPIDefinition,java.lang.Object>

finish

public void finish(io.micronaut.inject.visitor.VisitorContext visitorContext)

Specified by:

finish in interface io.micronaut.inject.visitor.TypeElementVisitor<io.swagger.v3.oas.annotations.OpenAPIDefinition,java.lang.Object>

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,
                                     @Nullable
                                     io.micronaut.inject.ast.Element classElement,
                                     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

classElement - The class element

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.