Package io.micronaut.maven.openapi

Class OpenApiServerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.micronaut.maven.AbstractMicronautMojo

io.micronaut.maven.openapi.AbstractOpenApiMojo

io.micronaut.maven.openapi.OpenApiServerMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-openapi-server",
      defaultPhase=GENERATE_SOURCES)
public class OpenApiServerMojo
extends AbstractOpenApiMojo

Generates an OpenAPI server. The sources are generated in the target directory.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	aotCompatible	If set to true, the generated code should be made compatible with Micronaut AOT.
protected String	controllerPackageName	The package name of the controller if controller implementation files are generated.
protected boolean	enabled	The property that defines if this mojo should be used in configuration.
protected boolean	fluxForArrays	Determines if the server should use flux for arrays.
protected boolean	generatedAnnotation	If set to true, the `javax.annotation.Generated` annotation will be added to all generated classes.
protected boolean	lombok	Determines if the server should use lombok.
static final String	MOJO_NAME
protected boolean	useAuth	Whether to generate authentication annotations for APIs.

Fields inherited from class io.micronaut.maven.openapi.AbstractOpenApiMojo

additionalEnumTypeAnnotations, additionalModelTypeAnnotations, additionalOneOfTypeAnnotations, additionalProperties, allowUnicodeIdentifiers, alwaysUseGenerateHttpResponse, apiNamePrefix, apiNameSuffix, apiPackageName, coroutines, dateTimeFormat, definitionFile, ensureUniqueParams, enumNameMapping, generateControllerAsAbstract, generateHttpResponseWhereRequired, generateSwaggerAnnotations, implicitHeaders, implicitHeadersRegex, importMapping, inlineSchemaNameMapping, inlineSchemaOption, invokerPackageName, jsonIncludeAlwaysForRequiredFields, ksp, lang, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackageName, nameMapping, openapiNormalizer, outputDirectory, outputKinds, parameterMappings, prependFormOrBodyParameters, project, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, requiredPropertiesInConstructor, responseBodyMappings, schemaMapping, serializationFramework, skipOperationExample, skipSortingOperations, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, typeMapping, useBeanValidation, useEnumCaseInsensitive, useJakartaEe, useOneOfInterfaces, useOptional, useReactive, useSealed

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
OpenApiServerMojo()

Method Summary

Modifier and Type	Method	Description
protected void	configureBuilder(io.micronaut.openapi.generator.MicronautCodeGeneratorBuilder builder)	Configures the OpenAPI generator.
protected boolean	isEnabled()	Determines if this mojo must be executed.

Methods inherited from class io.micronaut.maven.openapi.AbstractOpenApiMojo

execute

Methods inherited from class io.micronaut.maven.AbstractMicronautMojo

setLog

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setPluginContext

Methods inherited from class java.lang.Object

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

Field Details

MOJO_NAME

public static final String MOJO_NAME

See Also:

• Constant Field Values

controllerPackageName

@Parameter(property="micronaut.openapi.server.controller.package.name",
           defaultValue="io.micronaut.openapi.controller.package.name",
           required=true)
protected String controllerPackageName

The package name of the controller if controller implementation files are generated.

useAuth

@Parameter(property="micronaut.openapi.server.use.auth",
           defaultValue="false")
protected boolean useAuth

Whether to generate authentication annotations for APIs.

lombok

@Parameter(property="micronaut.openapi.server.lombok")
protected boolean lombok

Determines if the server should use lombok.

Since:

4.2.2

fluxForArrays

@Parameter(property="micronaut.openapi.server.flux.for.arrays")
protected boolean fluxForArrays

Determines if the server should use flux for arrays.

Since:

4.2.2

generatedAnnotation

@Parameter(property="micronaut.openapi.server.generated.annotation",
           defaultValue="true")
protected boolean generatedAnnotation

If set to true, the `javax.annotation.Generated` annotation will be added to all generated classes.

Since:

4.2.2

aotCompatible

@Parameter(property="micronaut.openapi.server.aot.compatible")
protected boolean aotCompatible

If set to true, the generated code should be made compatible with Micronaut AOT.

Since:

4.2.2

enabled

@Parameter(property="micronaut.openapi.generate.server")
protected boolean enabled

The property that defines if this mojo should be used in configuration.

Constructor Details

OpenApiServerMojo

public OpenApiServerMojo()

Method Details

isEnabled

protected boolean isEnabled()

Description copied from class: AbstractOpenApiMojo

Determines if this mojo must be executed.

Specified by:

isEnabled in class AbstractOpenApiMojo

Returns:

true if the mojo is enabled

configureBuilder

protected void configureBuilder(io.micronaut.openapi.generator.MicronautCodeGeneratorBuilder builder)

Description copied from class: AbstractOpenApiMojo

Configures the OpenAPI generator. When this method is called, common properties shared by all generators have already been configured, so this method should only take care of configuring the generator specific parameters.

Specified by:

configureBuilder in class AbstractOpenApiMojo

Parameters:

builder - the generator configuration builder