A C D F G H I J M O P R S T U V

A

AbstractOpenApiEndpointVisitor<C,E> - Class in io.micronaut.openapi.visitor

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

AbstractOpenApiEndpointVisitor() - Constructor for class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

C

classTags - Variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

classTags(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the class tags.

classTags(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

classTags(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

consumesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the consumes media types.

consumesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

consumesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

D

description(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the description for the element.

description(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

description(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

F

finish(VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

fromSpecification(String, Properties) - Static method in class io.micronaut.openapi.view.OpenApiViewConfig

Creates an OpenApiViewConfig form a String representation.

G

getCandidateMethods() - Method in class io.micronaut.annotation.processing.visitor.JavaClassElementExt

Returns the methods of this class.

getDocumentation() - Method in class io.micronaut.annotation.processing.visitor.JavaMethodElementExt

getFluentBeanProperties() - Method in class io.micronaut.annotation.processing.visitor.JavaClassElementExt

Returns fluent accessor methods.

getGenericReturnType(MethodElement, VisitorContext) - Static method in class io.micronaut.annotation.processing.visitor.JavaClassElementExt

Returns the return type of the method.

getMethodDescription() - Method in class io.micronaut.openapi.javadoc.JavadocDescription

getParameters() - Method in class io.micronaut.openapi.javadoc.JavadocDescription

getReturnDescription() - Method in class io.micronaut.openapi.javadoc.JavadocDescription

The return description.

getReturnType(MethodElement, VisitorContext) - Static method in class io.micronaut.annotation.processing.visitor.JavaClassElementExt

Returns the return type of the method.

getSpecURL() - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Returns the relative openApi specification url path.

getTitle() - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Returns the title for the generated views.

H

httpMethod(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the HttpMethod of the element.

httpMethod(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

httpMethod(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

I

ignore(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns true if the specified element should not be processed.

ignore(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns true if the specified element should not be processed.

ignore(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

ignore(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

ignore(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

ignore(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

io.micronaut.annotation.processing.visitor - package io.micronaut.annotation.processing.visitor

io.micronaut.openapi.javadoc - package io.micronaut.openapi.javadoc

io.micronaut.openapi.view - package io.micronaut.openapi.view

io.micronaut.openapi.visitor - package io.micronaut.openapi.visitor

isEnabled() - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Returns true when the generation of views is enabled.

J

JavaClassElementExt - Class in io.micronaut.annotation.processing.visitor

A class element returning data from a TypeElement.

JavaClassElementExt(ClassElement, VisitorContext) - Constructor for class io.micronaut.annotation.processing.visitor.JavaClassElementExt

JavadocDescription - Class in io.micronaut.openapi.javadoc

A parsed javadoc description.

JavadocDescription() - Constructor for class io.micronaut.openapi.javadoc.JavadocDescription

JavadocParser - Class in io.micronaut.openapi.javadoc

Very simple javadoc parser that can used to parse out the first paragraph description and parameter / return descriptions.

JavadocParser() - Constructor for class io.micronaut.openapi.javadoc.JavadocParser

JavaMethodElementExt - Class in io.micronaut.annotation.processing.visitor

A method element returning data from a ExecutableElement.

M

methodSecurityRequirements(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the security requirements at method level.

methodSecurityRequirements(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

methodSecurityRequirements(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

methodServers(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the servers at method level.

methodServers(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

methodServers(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

MICRONAUT_OPENAPI_ADDITIONAL_FILES - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

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

MICRONAUT_OPENAPI_CONFIG_FILE - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

System property that enables setting the open api config file.

MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

System property for server context path.

MICRONAUT_OPENAPI_ENDPOINT_CLASS_TAGS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

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

MICRONAUT_OPENAPI_ENDPOINT_SECURITY_REQUIREMENTS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

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

MICRONAUT_OPENAPI_ENDPOINT_SERVERS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

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

MICRONAUT_OPENAPI_EXPAND_PREFIX - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

Prefix for expandable properties.

MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

System property for naming strategy.

MICRONAUT_OPENAPI_TARGET_FILE - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

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

MICRONAUT_OPENAPI_VIEWS_SPEC - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

System property for views specification.

O

OPENAPI_CONFIG_FILE - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

Default openapi config file.

OpenApiApplicationVisitor - Class in io.micronaut.openapi.visitor

Visits the application class.

OpenApiApplicationVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

OpenApiControllerVisitor - Class in io.micronaut.openapi.visitor

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

OpenApiControllerVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiControllerVisitor

OpenApiEndpointVisitor - Class in io.micronaut.openapi.visitor

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

OpenApiEndpointVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

OpenApiViewConfig - Class in io.micronaut.openapi.view

OpenApi view configuration for Swagger-ui, ReDoc and RapiDoc.

P

parse(String) - Method in class io.micronaut.openapi.javadoc.JavadocParser

Parse the javadoc in a JavadocDescription.

producesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the produces media types.

producesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

producesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

propertyPlaceholderResolver - Variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

R

render(Path, VisitorContext) - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Generates the views given this configuration.

S

setMethodDescription(String) - Method in class io.micronaut.openapi.javadoc.JavadocDescription

Sets the method description.

setReturnDescription(String) - Method in class io.micronaut.openapi.javadoc.JavadocDescription

Sets the return description.

setServerContextPath(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Sets the server context path.

setSpecFile(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Sets the generated openApi specification file name.

setTitle(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Sets the title for the generated views.

T

toString() - Method in class io.micronaut.openapi.view.OpenApiViewConfig

U

uriMatchTemplates(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

Returns the uri paths of the element.

uriMatchTemplates(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

uriMatchTemplates(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor

V

visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

visitMethod(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor

A C D F G H I J M O P R S T U V