Package io.micronaut.openapi.generator

Interface MicronautCodeGeneratorOptionsBuilder

public interface MicronautCodeGeneratorOptionsBuilder

Builder for generic options that the Micronaut code generator supports.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MicronautCodeGeneratorOptionsBuilder.DateTimeFormat	The possible date-time formatting configurations.
static enum	MicronautCodeGeneratorOptionsBuilder.GeneratorLanguage	The possible languages for generator.

Method Summary

Modifier and Type	Method	Description
MicronautCodeGeneratorOptionsBuilder	withApiNamePrefix(String apiNamePrefix)	Set the api name prefix.
MicronautCodeGeneratorOptionsBuilder	withApiNameSuffix(String apiNameSuffix)	Set the api name suffix.
MicronautCodeGeneratorOptionsBuilder	withApiPackage(String apiPackage)	Sets the package of the generated API classes.
MicronautCodeGeneratorOptionsBuilder	withArtifactId(String artifactId)	Sets the artifact id of the project.
MicronautCodeGeneratorOptionsBuilder	withBeanValidation(boolean beanValidation)	If set to true, the generated code will use bean validation.
MicronautCodeGeneratorOptionsBuilder	withDateTimeFormat(MicronautCodeGeneratorOptionsBuilder.DateTimeFormat format)	Configure the date-time format.
MicronautCodeGeneratorOptionsBuilder	withEnumNameMapping(Map<String,String> enumNameMapping)	Add the enum name mappings.
MicronautCodeGeneratorOptionsBuilder	withGenerateHttpResponseAlways(boolean generateHttpResponseAlways)	If true, the generated operation return types will be wrapped in HttpResponse.
MicronautCodeGeneratorOptionsBuilder	withGenerateHttpResponseWhereRequired(boolean generateHttpResponseWhereRequired)	Wrap the operations response in HttpResponse object where non-200 HTTP status codes or additional headers are defined.
MicronautCodeGeneratorOptionsBuilder	withImportMapping(Map<String,String> importMapping)	Add the import mappings.
MicronautCodeGeneratorOptionsBuilder	withInlineSchemaNameMapping(Map<String,String> inlineSchemaNameMapping)	Add the inline schema name mappings.
MicronautCodeGeneratorOptionsBuilder	withInlineSchemaOption(Map<String,String> inlineSchemaOption)	Add the inline schema options.
MicronautCodeGeneratorOptionsBuilder	withInvokerPackage(String invokerPackage)	Sets the package of the generated invoker classes.
MicronautCodeGeneratorOptionsBuilder	withLang(MicronautCodeGeneratorOptionsBuilder.GeneratorLanguage lang)	Sets the generator language.
MicronautCodeGeneratorOptionsBuilder	withModelNameMapping(Map<String,String> modelNameMapping)	Add the model name mappings.
MicronautCodeGeneratorOptionsBuilder	withModelNamePrefix(String modelNamePrefix)	Set the model name prefix.
MicronautCodeGeneratorOptionsBuilder	withModelNameSuffix(String modelNameSuffix)	Set the model name suffix.
MicronautCodeGeneratorOptionsBuilder	withModelPackage(String modelPackage)	Sets the package of the generated model classes.
MicronautCodeGeneratorOptionsBuilder	withNameMapping(Map<String,String> nameMapping)	Add the name mappings.
MicronautCodeGeneratorOptionsBuilder	withOpenapiNormalizer(Map<String,String> openapiNormalizer)	Add the OpenAPi normalizer options.
MicronautCodeGeneratorOptionsBuilder	withOptional(boolean optional)	If set to true, the generated code will make use of Optional.
MicronautCodeGeneratorOptionsBuilder	withParameterMappings(List<ParameterMapping> parameterMappings)	Add the parameter mappings.
MicronautCodeGeneratorOptionsBuilder	withReactive(boolean reactive)	If set to true, the generator will use reactive types.
MicronautCodeGeneratorOptionsBuilder	withResponseBodyMappings(List<ResponseBodyMapping> responseBodyMappings)	Add the response body mappings.
MicronautCodeGeneratorOptionsBuilder	withSchemaMapping(Map<String,String> schemaMapping)	Add the schema mappings.
MicronautCodeGeneratorOptionsBuilder	withSerializationLibrary(SerializationLibraryKind library)	Configure the serialization library.
MicronautCodeGeneratorOptionsBuilder	withTestFramework(MicronautCodeGeneratorEntryPoint.TestFramework testFramework)	Configures the test framework to use for generated tests.
MicronautCodeGeneratorOptionsBuilder	withTypeMapping(Map<String,String> typeMapping)	Add the type mappings.

Method Details

withLang

MicronautCodeGeneratorOptionsBuilder withLang(MicronautCodeGeneratorOptionsBuilder.GeneratorLanguage lang)

Sets the generator language.

Parameters:

lang - generator language

Returns:

this builder

withApiPackage

MicronautCodeGeneratorOptionsBuilder withApiPackage(String apiPackage)

Sets the package of the generated API classes.

Parameters:

apiPackage - the package name

Returns:

this builder

withInvokerPackage

MicronautCodeGeneratorOptionsBuilder withInvokerPackage(String invokerPackage)

Sets the package of the generated invoker classes.

Parameters:

invokerPackage - the package name

Returns:

this builder

withModelPackage

MicronautCodeGeneratorOptionsBuilder withModelPackage(String modelPackage)

Sets the package of the generated model classes.

Parameters:

modelPackage - the package name

Returns:

this builder

withArtifactId

MicronautCodeGeneratorOptionsBuilder withArtifactId(String artifactId)

Sets the artifact id of the project.

Parameters:

artifactId - the artifact id

Returns:

this builder

withParameterMappings

MicronautCodeGeneratorOptionsBuilder withParameterMappings(List<ParameterMapping> parameterMappings)

Add the parameter mappings.

Parameters:

parameterMappings - the parameter mappings specified by a ParameterMapping objects

Returns:

this builder

withResponseBodyMappings

MicronautCodeGeneratorOptionsBuilder withResponseBodyMappings(List<ResponseBodyMapping> responseBodyMappings)

Add the response body mappings.

Parameters:

responseBodyMappings - the response body mappings specified by a ResponseBodyMapping objects

Returns:

this builder

withSchemaMapping

MicronautCodeGeneratorOptionsBuilder withSchemaMapping(Map<String,String> schemaMapping)

Add the schema mappings.

Parameters:

schemaMapping - the schema mappings

Returns:

this builder

withImportMapping

MicronautCodeGeneratorOptionsBuilder withImportMapping(Map<String,String> importMapping)

Add the import mappings.

Parameters:

importMapping - the import mappings

Returns:

this builder

withNameMapping

MicronautCodeGeneratorOptionsBuilder withNameMapping(Map<String,String> nameMapping)

Add the name mappings.

Parameters:

nameMapping - the name mappings

Returns:

this builder

withTypeMapping

MicronautCodeGeneratorOptionsBuilder withTypeMapping(Map<String,String> typeMapping)

Add the type mappings.

Parameters:

typeMapping - the type mappings

Returns:

this builder

withEnumNameMapping

MicronautCodeGeneratorOptionsBuilder withEnumNameMapping(Map<String,String> enumNameMapping)

Add the enum name mappings.

Parameters:

enumNameMapping - the enum name mappings

Returns:

this builder

withModelNameMapping

MicronautCodeGeneratorOptionsBuilder withModelNameMapping(Map<String,String> modelNameMapping)

Add the model name mappings.

Parameters:

modelNameMapping - the model name mappings

Returns:

this builder

withInlineSchemaNameMapping

MicronautCodeGeneratorOptionsBuilder withInlineSchemaNameMapping(Map<String,String> inlineSchemaNameMapping)

Add the inline schema name mappings.

Parameters:

inlineSchemaNameMapping - the inline schema name mappings

Returns:

this builder

withInlineSchemaOption

MicronautCodeGeneratorOptionsBuilder withInlineSchemaOption(Map<String,String> inlineSchemaOption)

Add the inline schema options.

Parameters:

inlineSchemaOption - the inline schema options

Returns:

this builder

withOpenapiNormalizer

MicronautCodeGeneratorOptionsBuilder withOpenapiNormalizer(Map<String,String> openapiNormalizer)

Add the OpenAPi normalizer options.

Parameters:

openapiNormalizer - the OpenAPi normalizer options

Returns:

this builder

withApiNamePrefix

MicronautCodeGeneratorOptionsBuilder withApiNamePrefix(String apiNamePrefix)

Set the api name prefix.

Parameters:

apiNamePrefix - the api name prefix

Returns:

this builder

withApiNameSuffix

MicronautCodeGeneratorOptionsBuilder withApiNameSuffix(String apiNameSuffix)

Set the api name suffix.

Parameters:

apiNameSuffix - the api name suffix

Returns:

this builder

withModelNamePrefix

MicronautCodeGeneratorOptionsBuilder withModelNamePrefix(String modelNamePrefix)

Set the model name prefix.

Parameters:

modelNamePrefix - the model name prefix

Returns:

this builder

withModelNameSuffix

MicronautCodeGeneratorOptionsBuilder withModelNameSuffix(String modelNameSuffix)

Set the model name suffix.

Parameters:

modelNameSuffix - the model name suffix

Returns:

this builder

withReactive

MicronautCodeGeneratorOptionsBuilder withReactive(boolean reactive)

If set to true, the generator will use reactive types.

Parameters:

reactive - the reactive flag

Returns:

this builder

withGenerateHttpResponseAlways

MicronautCodeGeneratorOptionsBuilder withGenerateHttpResponseAlways(boolean generateHttpResponseAlways)

If true, the generated operation return types will be wrapped in HttpResponse.

Parameters:

generateHttpResponseAlways - the wrapping flag

Returns:

this builder

withGenerateHttpResponseWhereRequired

MicronautCodeGeneratorOptionsBuilder withGenerateHttpResponseWhereRequired(boolean generateHttpResponseWhereRequired)

Wrap the operations response in HttpResponse object where non-200 HTTP status codes or additional headers are defined.

Parameters:

generateHttpResponseWhereRequired - the wrapping flag

Returns:

this builder

withBeanValidation

MicronautCodeGeneratorOptionsBuilder withBeanValidation(boolean beanValidation)

If set to true, the generated code will use bean validation.

Parameters:

beanValidation - the bean validation flag

Returns:

this builder

withOptional

MicronautCodeGeneratorOptionsBuilder withOptional(boolean optional)

If set to true, the generated code will make use of Optional.

Parameters:

optional - the optional flag

Returns:

this builder

withTestFramework

MicronautCodeGeneratorOptionsBuilder withTestFramework(MicronautCodeGeneratorEntryPoint.TestFramework testFramework)

Configures the test framework to use for generated tests.

Parameters:

testFramework - the test framework

Returns:

this builder

withSerializationLibrary

MicronautCodeGeneratorOptionsBuilder withSerializationLibrary(SerializationLibraryKind library)

Configure the serialization library.

Parameters:

library - the serialization library.

Returns:

this builder

withDateTimeFormat

MicronautCodeGeneratorOptionsBuilder withDateTimeFormat(MicronautCodeGeneratorOptionsBuilder.DateTimeFormat format)

Configure the date-time format.

Parameters:

format - the date-time format.

Returns:

this builder