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 <franz@see.net.ph> <https://see.net.ph>
-
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, withXmlFields 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, vendorExtensionsFields inherited from interface io.swagger.codegen.v3.generators.features.BeanValidationFeatures
USE_BEANVALIDATIONFields inherited from interface io.swagger.codegen.v3.generators.features.OptionalFeatures
USE_OPTIONAL -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars) voidaddOperationToGroup(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 groupgetHelp()getName()io.swagger.codegen.v3.CodegenTypegetTag()voidpostProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property) postProcessModelsEnum(Map<String, Object> objs) post process enum defined in model's propertiespostProcessOperations(Map<String, Object> objs) voidpreprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) voidvoidsetBasePackage(String configPackage) voidsetConfigPackage(String configPackage) voidsetImplicitHeaders(boolean implicitHeaders) voidvoidsetUseBeanValidation(boolean useBeanValidation) voidsetUseOptional(boolean useOptional) voidsetUseTags(boolean useTags) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is emptytoApiTestFilename(String name) Return the file name of the Api TesttoBooleanGetter(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, writePropertyBackMethods 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, writeOptionalMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.swagger.codegen.v3.CodegenConfig
getCodeName, getPriority, isPrivileged
-
Constructor Details
-
MicronautCodegen
public MicronautCodegen()
-
-
Method Details
-
getTag
public io.swagger.codegen.v3.CodegenType getTag()- Specified by:
getTagin interfaceio.swagger.codegen.v3.CodegenConfig
-
getName
- Specified by:
getNamein interfaceio.swagger.codegen.v3.CodegenConfig
-
getHelp
- Specified by:
getHelpin interfaceio.swagger.codegen.v3.CodegenConfig
-
processOpts
public void processOpts()- Specified by:
processOptsin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
processOptsin classAbstractJavaCodegen
-
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:DefaultCodegenConfigAdd operation to group- Specified by:
addOperationToGroupin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
addOperationToGroupin classDefaultCodegenConfig- Parameters:
tag- name of the tagresourcePath- path of the resourceoperation- Swagger Operation objectco- Codegen Operation objectoperations- map of Codegen operations
-
getArgumentsLocation
- Overrides:
getArgumentsLocationin classDefaultCodegenConfig
-
getDefaultTemplateDir
- Specified by:
getDefaultTemplateDirin classDefaultCodegenConfig
-
preprocessOpenAPI
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) - Specified by:
preprocessOpenAPIin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
preprocessOpenAPIin classAbstractJavaCodegen
-
postProcessOperations
- Specified by:
postProcessOperationsin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessOperationsin classAbstractJavaCodegen
-
postProcessSupportingFileData
- Specified by:
postProcessSupportingFileDatain interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessSupportingFileDatain classDefaultCodegenConfig
-
toApiName
Description copied from class:DefaultCodegenConfigOutput the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty- Specified by:
toApiNamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toApiNamein classAbstractJavaCodegen- Parameters:
name- the name of the Api- Returns:
- capitalized Api name ending with "Api"
-
toApiTestFilename
Description copied from class:DefaultCodegenConfigReturn the file name of the Api Test- Specified by:
toApiTestFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toApiTestFilenamein classAbstractJavaCodegen- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toBooleanGetter
Description copied from class:AbstractJavaCodegenOutput the Getter name for boolean property, e.g. isActive- Specified by:
toBooleanGetterin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
toBooleanGetterin classAbstractJavaCodegen- Parameters:
name- the name of the property- Returns:
- getter name based on naming convention
-
setTitle
-
setConfigPackage
-
setBasePackage
-
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:
postProcessModelPropertyin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessModelPropertyin classAbstractJavaCodegen
-
postProcessModelsEnum
Description copied from class:DefaultCodegenConfigpost process enum defined in model's properties- Overrides:
postProcessModelsEnumin classDefaultCodegenConfig- Parameters:
objs- Map of models- Returns:
- maps of models with better enum support
-
setUseBeanValidation
public void setUseBeanValidation(boolean useBeanValidation) - Specified by:
setUseBeanValidationin interfaceBeanValidationFeatures
-
setUseOptional
public void setUseOptional(boolean useOptional) - Specified by:
setUseOptionalin interfaceOptionalFeatures
-
addHandlebarHelpers
public void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars) - Specified by:
addHandlebarHelpersin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
addHandlebarHelpersin classAbstractJavaCodegen
-