Package io.swagger.codegen.v3.generators.java

Class MicronautCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

io.swagger.codegen.v3.generators.java.MicronautCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig, BeanValidationFeatures, OptionalFeatures

public class MicronautCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures, OptionalFeatures

Author:

Franz See

Field Summary

Fields inherited from class io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, CHECK_DUPLICATED_MODEL_NAME, DATE_LIBRARY, dateLibrary, developerEmail, developerName, developerOrganization, developerOrganizationUrl, ERROR_ON_UNKNOWN_ENUM, FULL_JAVA_UTIL, fullJavaUtil, groupId, invokerPackage, jakarta, JAKARTA, JAVA11_MODE, java11Mode, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, localVariablePrefix, modelDocPath, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_JAVA6, supportJava6, testFolder, USE_NULLABLE_FOR_NOTNULL, useNullableForNotNull, WIREMOCK_OPTION, WITH_XML, withXml

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Fields inherited from interface io.swagger.codegen.v3.generators.features.BeanValidationFeatures

USE_BEANVALIDATION

Fields inherited from interface io.swagger.codegen.v3.generators.features.OptionalFeatures

USE_OPTIONAL

Constructor Summary

Constructors

Constructor	Description
MicronautCodegen()

Method Summary

Modifier and Type	Method	Description
void	addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)
void	addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, io.swagger.codegen.v3.CodegenOperation co, Map<String,List<io.swagger.codegen.v3.CodegenOperation>> operations)	Add operation to group
String	getArgumentsLocation()
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
io.swagger.codegen.v3.CodegenType	getTag()
void	postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
Map<String,Object>	postProcessModelsEnum(Map<String,Object> objs)	post process enum defined in model's properties
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
void	setBasePackage(String configPackage)
void	setConfigPackage(String configPackage)
void	setImplicitHeaders(boolean implicitHeaders)
void	setTitle(String title)
void	setUseBeanValidation(boolean useBeanValidation)
void	setUseOptional(boolean useOptional)
void	setUseTags(boolean useTags)
String	toApiName(String name)	Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toApiTestFilename(String name)	Return the file name of the Api Test
String	toBooleanGetter(String name)	Output the Getter name for boolean property, e.g.

Methods inherited from class io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

addAdditionPropertiesToCodeGenModel, apiDocFileFolder, apiFileFolder, apiTestFileFolder, camelizeVarName, checkAliasModel, checkDuplicatedModelNameIgnoringCase, convertPropertyToBoolean, escapeQuotationMark, escapeReservedWord, escapeUnderscore, escapeUnsafeCharacters, fixUpParentAndInterfaces, fromModel, fromOperation, getAlias, getSchemaType, getTypeDeclaration, isSameEnum, modelDocFileFolder, modelFileFolder, needToImport, postProcessModels, postProcessParameter, replaceDuplicatedInModelProperties, replaceDuplicatedInPaths, sanitizeTag, sanitizeVarName, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setFullJavaUtil, setGroupId, setInvokerPackage, setJakarta, setJava11Mode, setJava8Mode, setLanguageArguments, setLicenseName, setLicenseUrl, setLocalVariablePrefix, setParameterExampleValue, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportJava6, setTestFolder, setUseNullableForNotnull, setWithXml, toApiDocFilename, toApiFilename, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toOperationId, toParamName, toRegularExpression, toVarName, writePropertyBack

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addCodegenContentParameters, addConsumesInfo, addImport, additionalProperties, addOperationImports, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessOperationsWithModels, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

getCodeName, getPriority, isPrivileged

Constructor Detail

MicronautCodegen

public MicronautCodegen()

Method Detail

getTag

public io.swagger.codegen.v3.CodegenType getTag()

Specified by:

getTag in interface io.swagger.codegen.v3.CodegenConfig

getName

public String getName()

Specified by:

getName in interface io.swagger.codegen.v3.CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface io.swagger.codegen.v3.CodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class AbstractJavaCodegen

addOperationToGroup

public void addOperationToGroup(String tag,
                                String resourcePath,
                                io.swagger.v3.oas.models.Operation operation,
                                io.swagger.codegen.v3.CodegenOperation co,
                                Map<String,List<io.swagger.codegen.v3.CodegenOperation>> operations)

Description copied from class: DefaultCodegenConfig

Add operation to group

Specified by:

addOperationToGroup in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

addOperationToGroup in class DefaultCodegenConfig

Parameters:

tag - name of the tag

resourcePath - path of the resource

operation - Swagger Operation object

co - Codegen Operation object

operations - map of Codegen operations

getArgumentsLocation

public String getArgumentsLocation()

Overrides:

getArgumentsLocation in class DefaultCodegenConfig

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

preprocessOpenAPI

public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Specified by:

preprocessOpenAPI in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

preprocessOpenAPI in class AbstractJavaCodegen

postProcessOperations

public Map<String,Object> postProcessOperations(Map<String,Object> objs)

Specified by:

postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessOperations in class AbstractJavaCodegen

postProcessSupportingFileData

public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)

Specified by:

postProcessSupportingFileData in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegenConfig

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegenConfig

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiName in class AbstractJavaCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toApiTestFilename

public String toApiTestFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiTestFilename in class AbstractJavaCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toBooleanGetter

public String toBooleanGetter(String name)

Description copied from class: AbstractJavaCodegen

Output the Getter name for boolean property, e.g. isActive

Specified by:

toBooleanGetter in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toBooleanGetter in class AbstractJavaCodegen

Parameters:

name - the name of the property

Returns:

getter name based on naming convention

setTitle

public void setTitle(String title)

setConfigPackage

public void setConfigPackage(String configPackage)

setBasePackage

public void setBasePackage(String configPackage)

setUseTags

public void setUseTags(boolean useTags)

setImplicitHeaders

public void setImplicitHeaders(boolean implicitHeaders)

postProcessModelProperty

public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
                                     io.swagger.codegen.v3.CodegenProperty property)

Specified by:

postProcessModelProperty in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModelProperty in class AbstractJavaCodegen

postProcessModelsEnum

public Map<String,Object> postProcessModelsEnum(Map<String,Object> objs)

Description copied from class: DefaultCodegenConfig

post process enum defined in model's properties

Overrides:

postProcessModelsEnum in class DefaultCodegenConfig

Parameters:

objs - Map of models

Returns:

maps of models with better enum support

setUseBeanValidation

public void setUseBeanValidation(boolean useBeanValidation)

Specified by:

setUseBeanValidation in interface BeanValidationFeatures

setUseOptional

public void setUseOptional(boolean useOptional)

Specified by:

setUseOptional in interface OptionalFeatures

addHandlebarHelpers

public void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)

Specified by:

addHandlebarHelpers in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

addHandlebarHelpers in class AbstractJavaCodegen