Package io.micronaut.maven.openapi

Class OpenApiClientMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.micronaut.maven.AbstractMicronautMojo

io.micronaut.maven.openapi.AbstractOpenApiMojo

io.micronaut.maven.openapi.OpenApiClientMojo

All Implemented Interfaces:

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	additionalTypeAnnotations	Additional annotations to be used on the generated client API classes.
protected String	authorizationFilterPattern	The pattern for authorization filter.
protected String	basePathSeparator	The base path separator.
protected String	clientId	Client id.
protected boolean	clientPath	If set to true, Api annotation @Client will be with `path` attribute.
protected boolean	enabled	The property that defines if this mojo is used.
protected boolean	fluxForArrays	Determines if the client 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 client should use lombok.
static final String	MOJO_NAME
protected boolean	useAuth	Whether to configure authentication for client.

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
OpenApiClientMojo()

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

clientId

@Parameter(property="micronaut.openapi.client.id")
protected String clientId

Client id.

clientPath

@Parameter(property="micronaut.openapi.client.path")
protected boolean clientPath

If set to true, Api annotation @Client will be with `path` attribute.

useAuth

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

Whether to configure authentication for client.

additionalTypeAnnotations

@Parameter(property="micronaut.openapi.client.additional.type.annotations")
protected List<String> additionalTypeAnnotations

Additional annotations to be used on the generated client API classes.

basePathSeparator

@Parameter(property="micronaut.openapi.client.base.path.separator")
protected String basePathSeparator

The base path separator.

authorizationFilterPattern

@Parameter(property="micronaut.openapi.client.authorization.filter.pattern")
protected String authorizationFilterPattern

The pattern for authorization filter.

enabled

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

The property that defines if this mojo is used.

lombok

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

Determines if the client should use lombok.

Since:

4.2.2

fluxForArrays

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

Determines if the client should use flux for arrays.

Since:

4.2.2

generatedAnnotation

@Parameter(property="micronaut.openapi.client.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

Constructor Details

OpenApiClientMojo

public OpenApiClientMojo()

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