Interface OpenApiServerSpec

All Superinterfaces:

OpenApiSpec

public interface OpenApiServerSpec
extends OpenApiSpec

Method Summary

Modifier and Type	Method	Description
org.gradle.api.provider.Property<Boolean>	getAot()	Whether to generate server code prepared for Micronaut AOT scenarios.
org.gradle.api.provider.Property<String>	getControllerPackage()	Package used for generated server controller types.
org.gradle.api.provider.Property<Boolean>	getGenerateHardNullable()	Whether Java server models should distinguish required nullable properties more strictly in generated code.
org.gradle.api.provider.Property<Boolean>	getGenerateStreamingFileUpload()	Whether generated server operations should support streaming file upload types.
org.gradle.api.provider.Property<Boolean>	getUseAuth()	Whether to generate server-side authentication annotations and support for OpenAPI security requirements.

Methods inherited from interface OpenApiSpec

getAdditionalEnumTypeAnnotations, getAdditionalModelTypeAnnotations, getAdditionalOneOfTypeAnnotations, getAdditionalProperties, getAllowUnicodeIdentifiers, getAlwaysUseGenerateHttpResponse, getApiNamePrefix, getApiNameSuffix, getApiPackageName, getCoroutines, getDateTimeFormat, getEnsureUniqueParams, getEnumNameMapping, getFluxForArrays, getGenerateApis, getGenerateControllerAsAbstract, getGeneratedAnnotation, getGenerateEnumConverters, getGenerateHttpResponseWhereRequired, getGenerateModels, getGenerateOperationOnlyForFirstTag, getGenerateSwaggerAnnotations, getImplicitHeaders, getImplicitHeadersRegex, getImportMapping, getInlineSchemaNameMapping, getInlineSchemaOption, getInvokerPackageName, getJavaCompatibility, getJsonIncludeAlwaysForRequiredFields, getJvmOverloads, getJvmRecord, getKsp, getLang, getLombok, getModelNameMapping, getModelNamePrefix, getModelNameSuffix, getModelPackageName, getNameMapping, getNoArgsConstructor, getOpenapiNormalizer, getParameterMappings, getPrependFormOrBodyParameters, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getRequiredPropertiesInConstructor, getResponseBodyMappings, getSchemaMapping, getSerializationFramework, getSkipOperationExample, getSkipSortingOperations, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getTypeMapping, getUseBeanValidation, getUseEnumCaseInsensitive, getUseJakartaEe, getUseOneOfInterfaces, getUseOptional, getUseReactive, getUserParameterMode, getUseSealed, getUseTags, getUseUrlConnectionCache

Method Details

getControllerPackage

org.gradle.api.provider.Property<String> getControllerPackage()

Package used for generated server controller types.

Defaults to "io.micronaut.openapi.controller".

Returns:

the generated controller package

getUseAuth

org.gradle.api.provider.Property<Boolean> getUseAuth()

Whether to generate server-side authentication annotations and support for OpenAPI security requirements.

Defaults to false. When enabled, the generated server sources may require Micronaut Security dependencies in the consuming application.

Returns:

whether server authentication support is generated

getAot

org.gradle.api.provider.Property<Boolean> getAot()

Whether to generate server code prepared for Micronaut AOT scenarios.

Defaults to false.

Returns:

whether AOT-oriented server code is generated

getGenerateHardNullable

org.gradle.api.provider.Property<Boolean> getGenerateHardNullable()

Whether Java server models should distinguish required nullable properties more strictly in generated code.

Defaults to true. This option applies to Java server generation.

Returns:

whether hard nullable model handling is generated

getGenerateStreamingFileUpload

org.gradle.api.provider.Property<Boolean> getGenerateStreamingFileUpload()

Whether generated server operations should support streaming file upload types.

Defaults to false.

Returns:

whether streaming file upload support is generated