Package io.micronaut.openapi.generator

Class JavaMicronautServerCodegen

java.lang.Object
org.openapitools.codegen.DefaultCodegen
org.openapitools.codegen.languages.AbstractJavaCodegen
io.micronaut.openapi.generator.AbstractMicronautJavaCodegen<JavaMicronautServerOptionsBuilder>
io.micronaut.openapi.generator.JavaMicronautServerCodegen
All Implemented Interfaces:
MicronautCodeGenerator<JavaMicronautServerOptionsBuilder>, org.openapitools.codegen.CodegenConfig, org.openapitools.codegen.languages.features.BeanValidationFeatures, org.openapitools.codegen.languages.features.DocumentationProviderFeatures, org.openapitools.codegen.languages.features.OptionalFeatures
public class JavaMicronautServerCodegen extends AbstractMicronautJavaCodegen<JavaMicronautServerOptionsBuilder>
The generator for creating Micronaut servers.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.openapitools.codegen.languages.features.DocumentationProviderFeatures

    org.openapitools.codegen.languages.features.DocumentationProviderFeatures.AnnotationLibrary, org.openapitools.codegen.languages.features.DocumentationProviderFeatures.DocumentationProvider

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ANONYMOUS_ROLE
     
    static final String
    ANONYMOUS_ROLE_KEY
     
    protected boolean
    aot
     
    protected static final String
    API_PREFIX
     
    protected static final String
    API_SUFFIX
     
    protected String
    apiPackage
     
    static final String
    AUTHORIZED_ROLE
     
    static final String
    AUTHORIZED_ROLE_KEY
     
    protected static final String
    CONTROLLER_PREFIX
     
    protected static final String
    CONTROLLER_SUFFIX
     
    protected String
    controllerPackage
     
    static final String
    DENY_ALL_ROLE
     
    static final String
    DENY_ALL_ROLE_KEY
     
    static final String
    EXTENSION_ROLES
     
    protected boolean
    generateControllerFromExamples
     
    protected boolean
    generateHardNullable
     
    protected boolean
    generateImplementationFiles
     
    protected boolean
    generateOperationsToReturnNotImplemented
     
    protected boolean
    generateStreamingFileUpload
     
    static final String
    NAME
     
    static final String
    OPT_AOT
     
    static final String
    OPT_CONTROLLER_PACKAGE
     
    static final String
    OPT_GENERATE_CONTROLLER_FROM_EXAMPLES
     
    static final String
    OPT_GENERATE_HARD_NULLABLE
     
    static final String
    OPT_GENERATE_IMPLEMENTATION_FILES
     
    static final String
    OPT_GENERATE_OPERATIONS_TO_RETURN_NOT_IMPLEMENTED
     
    static final String
    OPT_GENERATE_STREAMING_FILE_UPLOAD
     
    protected boolean
    useAuth
     

    Fields inherited from class io.micronaut.openapi.generator.AbstractMicronautJavaCodegen

    allModels, appName, CONTENT_TYPE_ANY, CONTENT_TYPE_APPLICATION_FORM_URLENCODED, CONTENT_TYPE_APPLICATION_JSON, CONTENT_TYPE_MULTIPART_FORM_DATA, fluxForArrays, generatedAnnotation, generateHttpResponseAlways, generateHttpResponseWhereRequired, generateOperationOnlyForFirstTag, generateSwaggerAnnotations, lombok, OPT_APPLICATION_NAME, OPT_DATE_FORMAT, OPT_DATE_LIBRARY_LOCAL_DATETIME, OPT_DATE_LIBRARY_OFFSET_DATETIME, OPT_DATE_LIBRARY_ZONED_DATETIME, OPT_DATETIME_FORMAT, OPT_FLUX_FOR_ARRAYS, OPT_GENERATE_HTTP_RESPONSE_ALWAYS, OPT_GENERATE_HTTP_RESPONSE_WHERE_REQUIRED, OPT_GENERATE_OPERATION_ONLY_FOR_FIRST_TAG, OPT_GENERATE_SWAGGER_ANNOTATIONS, OPT_GENERATE_SWAGGER_ANNOTATIONS_FALSE, OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_1, OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2, OPT_GENERATE_SWAGGER_ANNOTATIONS_TRUE, OPT_GENERATED_ANNOTATION, OPT_REACTIVE, OPT_REQUIRED_PROPERTIES_IN_CONSTRUCTOR, OPT_TEST, OPT_TEST_JUNIT, OPT_TEST_SPOCK, OPT_TITLE, OPT_USE_AUTH, OPT_USE_LOMBOK, OPT_USE_PLURAL, OPT_VISITABLE, parameterMappings, plural, random, reactive, requiredPropertiesInConstructor, responseBodyMappings, serializationLibrary, testTool, title, useBeanValidation, useOptional, visitable

    Fields inherited from class org.openapitools.codegen.languages.AbstractJavaCodegen

    ADDITIONAL_ENUM_TYPE_ANNOTATIONS, ADDITIONAL_MODEL_TYPE_ANNOTATIONS, ADDITIONAL_ONE_OF_TYPE_ANNOTATIONS, additionalEnumTypeAnnotations, additionalModelTypeAnnotations, additionalOneOfTypeAnnotations, annotationLibrary, apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, BOOLEAN_GETTER_PREFIX, booleanGetterPrefix, CAMEL_CASE_DOLLAR_SIGN, camelCaseDollarSign, CONTAINER_DEFAULT_TO_NULL, containerDefaultToNull, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, DEFAULT_TEST_FOLDER, developerEmail, developerName, developerOrganization, developerOrganizationUrl, DISABLE_HTML_ESCAPING, disableHtmlEscaping, DISCRIMINATOR_CASE_SENSITIVE, discriminatorCaseSensitive, documentationProvider, groupId, IGNORE_ANYOF_IN_ENUM, ignoreAnyOfInEnum, IMPLICIT_HEADERS, IMPLICIT_HEADERS_REGEX, implicitHeaders, implicitHeadersRegex, invokerPackage, JACKSON, JAVAX_PACKAGE, licenseName, licenseUrl, LOMBOK, lombokAnnotations, modelDocPath, OPENAPI_NULLABLE, openApiNullable, outputTestFolder, parentArtifactId, parentGroupId, parentOverridden, parentVersion, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, supportAsync, TEST_OUTPUT, testFolder, USE_JAKARTA_EE, USE_ONE_OF_INTERFACES, useJakartaEe, WITH_XML, withXml

    Fields inherited from class org.openapitools.codegen.DefaultCodegen

    additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiTemplateFiles, apiTestTemplateFiles, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumNameMapping, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN

    Fields inherited from interface org.openapitools.codegen.languages.features.BeanValidationFeatures

    USE_BEANVALIDATION

    Fields inherited from interface org.openapitools.codegen.languages.features.DocumentationProviderFeatures

    ANNOTATION_LIBRARY, DOCUMENTATION_PROVIDER

    Fields inherited from interface org.openapitools.codegen.languages.features.OptionalFeatures

    USE_OPTIONAL

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    apiTestFileFolder()
     
    String
    apiTestFilename(String templateName, String tag)
     
    String
    getHelp()
     
    String
    getName()
     
    org.openapitools.codegen.CodegenType
    getTag()
     
    boolean
    isGenerateHardNullable()
     
    boolean
    isServer()
     
    JavaMicronautServerOptionsBuilder
    optionsBuilder()
     
    org.openapitools.codegen.model.OperationsMap
    postProcessOperationsWithModels(org.openapitools.codegen.model.OperationsMap objs, List<org.openapitools.codegen.model.ModelMap> allModels)
     
    void
    processOpts()
     
    void
    setControllerPackage(String controllerPackage)
     
    void
    setGenerateControllerFromExamples(boolean generateControllerFromExamples)
     
    void
    setGenerateImplementationFiles(boolean generateImplementationFiles)
     
    void
    setGenerateOperationsToReturnNotImplemented(boolean generateOperationsToReturnNotImplemented)
     
    void
    setParameterExampleValue(org.openapitools.codegen.CodegenParameter p)
     
    void
    setUseAuth(boolean useAuth)
     

    Methods inherited from class io.micronaut.openapi.generator.AbstractMicronautJavaCodegen

    addEnumNameMapping, addImportMapping, addInlineSchemaNameMapping, addInlineSchemaOption, addModelNameMapping, addMustacheLambdas, addNameMapping, addOpenapiNormalizer, addOperationToGroup, addParameterMappings, addResponseBodyMappings, addSchemaMapping, addTypeMapping, escapeTextGroovy, fromModel, fromOperation, fromParameter, fromProperty, getExampleValue, getParameterExampleValue, getPropertyExampleValue, getterAndSetterCapitalize, isReservedWord, isVisitable, modelTestFileFolder, postProcessAllModels, preprocessOpenAPI, sanitizeTag, setApiNamePrefix, setApiNameSuffix, setApiPackage, setArtifactId, setDateTimeLibrary, setFluxForArrays, setGeneratedAnnotation, setGenerateHttpResponseAlways, setGenerateHttpResponseWhereRequired, setInvokerPackage, setLombok, setModelNamePrefix, setModelNameSuffix, setModelPackage, setPlural, setReactive, setSerializationLibrary, setTestTool, setUseBeanValidation, setUseOptional, setVisitable, testFileFolder, toApiName, toApiTestFilename, toApiVarName, toEnumValue, toModelTestFilename, toVarName

    Methods inherited from class org.openapitools.codegen.languages.AbstractJavaCodegen

    addAdditionPropertiesToCodeGenModel, addImports, addImportsToOneOfInterface, apiDocFileFolder, apiFileFolder, applyJakartaPackage, applyJavaxPackage, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, findByName, getAdditionalModelTypeAnnotations, getAdditionalOneOfTypeAnnotations, getAlias, getAnnotationLibrary, getArtifactDescription, getArtifactId, getArtifactUrl, getArtifactVersion, getBooleanGetterPrefix, getDateLibrary, getDeveloperEmail, getDeveloperName, getDeveloperOrganization, getDeveloperOrganizationUrl, getDocumentationProvider, getGroupId, getInvokerPackage, getLicenseName, getLicenseUrl, getOutputTestFolder, getSchemaType, getScmConnection, getScmDeveloperConnection, getScmUrl, getSerializableModel, getSourceFolder, getSupportedVendorExtensions, getTestFolder, getTypeDeclaration, handleImplicitHeaders, isAddNullableImports, isOpenApiNullable, isTypeErasedGenerics, modelDocFileFolder, modelFileFolder, needToImport, postProcessFile, postProcessModelProperty, postProcessModels, postProcessResponseWithProperty, setAdditionalEnumTypeAnnotations, setAdditionalModelTypeAnnotations, setAdditionalOneOfTypeAnnotations, setAnnotationLibrary, setArtifactDescription, setArtifactUrl, setArtifactVersion, setBooleanGetterPrefix, setCamelCaseDollarSign, setContainerDefaultToNull, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setDiscriminatorCaseSensitive, setDocumentationProvider, setGroupId, setIgnoreAnyOfInEnum, setImplicitHeaders, setImplicitHeadersRegex, setLicenseName, setLicenseUrl, setOpenApiNullable, setOutputDir, setOutputTestFolder, setParameterExampleValue, setParameterExampleValue, setParentArtifactId, setParentGroupId, setParentOverridden, setParentVersion, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setTestFolder, setUseJakartaEe, setWithXml, toApiDocFilename, toApiFilename, toArrayDefaultValue, toBooleanGetter, toDefaultParameterValue, toDefaultValue, toEnumName, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toOperationId, toParamName, toRegularExpression

    Methods inherited from class org.openapitools.codegen.DefaultCodegen

    addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, additionalProperties, addOneOfInterfaceModel, addOneOfNameExtension, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguage, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessEnumVars, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setAutosetConstants, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setNonArrayMapProperty, setOpenAPI, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiImport, toArrayModelParamName, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelImport, toModelImportMap, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBack

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.openapitools.codegen.CodegenConfig

    additionalProperties, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguage, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessParameter, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiImport, toGetter, toModelImport, toModelImportMap, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

    Methods inherited from interface org.openapitools.codegen.languages.features.DocumentationProviderFeatures

    defaultDocumentationProvider, supportedAnnotationLibraries, supportedDocumentationProvider