Package io.micronaut.openapi.generator
Class AbstractMicronautKotlinCodegen<T extends GeneratorOptionsBuilder>
java.lang.Object
org.openapitools.codegen.DefaultCodegen
org.openapitools.codegen.languages.AbstractKotlinCodegen
io.micronaut.openapi.generator.AbstractMicronautKotlinCodegen<T>
- Type Parameters:
T- The generator options builder.
- All Implemented Interfaces:
MicronautCodeGenerator<T>,org.openapitools.codegen.CodegenConfig,org.openapitools.codegen.languages.features.BeanValidationFeatures
- Direct Known Subclasses:
KotlinMicronautClientCodegen,KotlinMicronautServerCodegen
public abstract class AbstractMicronautKotlinCodegen<T extends GeneratorOptionsBuilder>
extends org.openapitools.codegen.languages.AbstractKotlinCodegen
implements org.openapitools.codegen.languages.features.BeanValidationFeatures, MicronautCodeGenerator<T>
Base generator for Micronaut.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen
org.openapitools.codegen.languages.AbstractKotlinCodegen.DataTypeAssigner -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringprotected Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected booleanprotected Stringprotected Stringprotected Stringprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprotected Stringprotected booleanprotected Stringprotected booleanprotected booleanprotected booleanprotected booleanprotected booleanprotected com.fasterxml.jackson.databind.ObjectMapperstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected List<ParameterMapping>protected booleanprotected SecureRandomprotected booleanprotected List<ResponseBodyMapping>protected Stringprotected Stringprotected Stringprotected booleanprotected booleanprotected booleanprotected booleanFields inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen
ADDITIONAL_MODEL_TYPE_ANNOTATIONS, additionalModelTypeAnnotations, apiDocPath, apiSuffix, artifactId, artifactVersion, enumPropertyNaming, groupId, JAVAX_PACKAGE, MODEL_MUTABLE, MODEL_MUTABLE_DESC, modelDocPath, nonPublicApi, packageName, parcelizeModels, propertyAdditionalKeywords, resourcesFolder, serializableModel, sourceFolder, testFolder, USE_JAKARTA_EE, useJakartaEeFields inherited from class org.openapitools.codegen.DefaultCodegen
additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, arrayDefaultToEmpty, arrayNullableDefaultToEmpty, arrayOptionalDefaultToEmpty, arrayOptionalNullableDefaultToEmpty, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, defaultToEmptyContainer, 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, mapDefaultToEmpty, mapNullableDefaultToEmpty, mapOptionalDefaultToEmpty, mapOptionalNullableDefaultToEmpty, 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, skipSortingOperations, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERNFields inherited from interface org.openapitools.codegen.languages.features.BeanValidationFeatures
USE_BEANVALIDATION -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddEnumNameMapping(Map<String, String> enumNameMapping) voidaddImportMapping(Map<String, String> importMapping) voidaddInlineSchemaNameMapping(Map<String, String> inlineSchemaNameMapping) voidaddInlineSchemaOption(Map<String, String> inlineSchemaOption) voidaddModelNameMapping(Map<String, String> modelNameMapping) protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> Preset map builder with commonly used Mustache lambdas.voidaddNameMapping(Map<String, String> nameMapping) voidaddOpenapiNormalizer(Map<String, String> openapiNormalizer) voidaddOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, org.openapitools.codegen.CodegenOperation co, Map<String, List<org.openapitools.codegen.CodegenOperation>> operations) Add operation to groupvoidaddParameterMappings(List<ParameterMapping> parameterMappings) voidaddResponseBodyMappings(List<ResponseBodyMapping> responseBodyMappings) voidaddSchemaMapping(Map<String, String> schemaMapping) voidaddTypeMapping(Map<String, String> typeMapping) protected org.openapitools.codegen.CodegenDiscriminatorcreateDiscriminator(String schemaName, io.swagger.v3.oas.models.media.Schema schema) org.openapitools.codegen.CodegenModelConvert OAS Model object to Codegen Model object.org.openapitools.codegen.CodegenOperationfromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers) Convert OAS Operation object to Codegen Operation objectorg.openapitools.codegen.CodegenParameterfromParameter(io.swagger.v3.oas.models.parameters.Parameter p, Set<String> imports) Convert OAS Parameter object to Codegen Parameter objectorg.openapitools.codegen.CodegenPropertyfromProperty(String name, io.swagger.v3.oas.models.media.Schema schema, boolean required, boolean schemaIsFromAdditionalProperties) Convert OAS Property object to Codegen Property object.org.openapitools.codegen.CodegenParameterfromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports, String bodyParameterName) List<org.openapitools.codegen.CodegenParameter>fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports) org.openapitools.codegen.CodegenResponsefromResponse(String responseCode, io.swagger.v3.oas.models.responses.ApiResponse response) Convert OAS Response object to Codegen Response objectgetExampleValue(String defaultValue, String example, String dataType, Boolean isModel, List<Object> allowableValues, String itemsType, String itemsExample, List<org.openapitools.codegen.CodegenProperty> requiredVars, boolean isProperty) protected StringgetParameterExampleValue(org.openapitools.codegen.CodegenParameter p) protected StringgetPropertyExampleValue(org.openapitools.codegen.CodegenProperty p) getSchemaType(io.swagger.v3.oas.models.media.Schema p) returns the OpenAPI type for the property.getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property.booleanprotected voidhandleImplicitHeaders(org.openapitools.codegen.CodegenOperation operation) This method removes all implicit header parameters from the list of parameters.static booleanabstract booleanisServer()booleanvoidpostProcessAllModels(Map<String, org.openapitools.codegen.model.ModelsMap> objs) org.openapitools.codegen.model.OperationsMappostProcessOperationsWithModels(org.openapitools.codegen.model.OperationsMap objs, List<org.openapitools.codegen.model.ModelMap> allModels) voidpreprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openApi) voidsanitizeTag(String tag) Sanitize tagvoidsetAdditionalEnumTypeAnnotations(List<String> additionalEnumTypeAnnotations) voidsetAdditionalOneOfTypeAnnotations(List<String> additionalOneOfTypeAnnotations) voidsetApiPackage(String apiPackage) voidsetArtifactId(String artifactId) voidsetCoroutines(boolean coroutines) voidsetDateFormat(String dateFormat) voidsetDateTimeFormat(String dateTimeFormat) voidsetDateTimeLibrary(String name) voidsetFluxForArrays(boolean fluxForArrays) voidsetGenerateControllerAsAbstract(boolean generateControllerAsAbstract) voidsetGeneratedAnnotation(boolean generatedAnnotation) voidsetGenerateEnumConverters(boolean generateEnumConverters) voidsetGenerateHttpResponseAlways(boolean generateHttpResponseAlways) voidsetGenerateHttpResponseWhereRequired(boolean generateHttpResponseWhereRequired) voidsetGenerateOperationOnlyForFirstTag(boolean generateOperationOnlyForFirstTag) voidsetGenerateSwaggerAnnotations(boolean generateSwaggerAnnotations) voidsetImplicitHeaders(boolean implicitHeaders) voidsetImplicitHeadersRegex(String implicitHeadersRegex) voidsetJavaCompatibility(boolean javaCompatibility) voidsetJsonIncludeAlwaysForRequiredFields(boolean jsonIncludeAlwaysForRequiredFields) voidsetJvmOverloads(boolean jvmOverloads) voidsetJvmRecord(boolean jvmRecord) voidsetKsp(boolean ksp) voidsetModelPackage(String modelPackage) voidsetPackageName(String packageName) voidsetParameterExampleValue(org.openapitools.codegen.CodegenParameter p) Return the example value of the parameter.voidsetParameterExampleValue(org.openapitools.codegen.CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter) Return the example value of the parameter.voidsetPlural(boolean plural) voidsetReactive(boolean reactive) voidsetSerializationLibrary(String serializationLibrary) voidsetTestTool(String testTool) voidsetUseBeanValidation(boolean useBeanValidation) voidsetUseEnumCaseInsensitive(boolean useEnumCaseInsensitive) voidsetUseOneOfInterfaces(Boolean useOneOfInterfaces) voidsetUseTags(boolean useTags) voidsetVisitable(boolean visitable) superSanitizeTag(String tag) Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is emptytoApiTestFilename(String name) Return the file name of the Api TesttoApiVarName(String name) Return the variable name in the ApitoDefaultValue(org.openapitools.codegen.CodegenProperty cp, io.swagger.v3.oas.models.media.Schema schema) Return the default value of the propertytoEnumValue(String value, String datatype) Return the enum value in the language specified format e.g.toEnumVarName(String value, String datatype) Return the sanitized variable name for enumtoModelName(String name) Converts the OpenAPI schema name to a model name suitable for the current code generator.toModelTestFilename(String name) Return the capitalized file name of the model testReturn the variable name by removing invalid characters and proper escaping if it's a reserved word.protected voidupdateEnumVarsWithExtensions(List<Map<String, Object>> enumVars, Map<String, Object> vendorExtensions, String dataType) Methods inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen
apiDocFileFolder, apiFileFolder, applyJakartaPackage, applyJavaxPackage, doDataTypeAssignment, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, generatorLanguage, getAdditionalModelTypeAnnotations, getEnumPropertyNaming, getParcelizeModels, isDataTypeString, isModelMutable, isReservedWord, isSerializableModel, modelDocFileFolder, modelFileFolder, needToImport, nonPublicApi, postProcessFile, postProcessModels, setAdditionalModelTypeAnnotations, setApiSuffix, setArtifactVersion, setEnumPropertyNaming, setGroupId, setNonPublicApi, setParcelizeModels, setSerializableModel, setSourceFolder, setTestFolder, setUseJakartaEe, toDefaultParameterValue, toEnumName, toModelFilename, toModelImport, toOperationId, toParamName, toRegularExpression, toVariableName, updateModelForObjectMethods inherited from class org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addOneOfInterfaceModel, addOneOfNameExtension, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, convertPropertyToBooleanAndWriteBack, convertPropertyToStringAndWriteBack, convertPropertyToTypeAndWriteBack, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextInSingleQuotes, escapeTextWhileAllowingNewLines, executePostProcessor, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromProperty, fromProperty, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getEnumValueForProperty, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getName, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTag, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isArrayDefaultToEmpty, isArrayNullableDefaultToEmpty, isArrayOptionalDefaultToEmpty, isArrayOptionalNullableDefaultToEmpty, isDataTypeBinary, isDataTypeFile, isDefaultToEmptyContainer, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isMapDefaultToEmpty, isMapNullableDefaultToEmpty, isMapOptionalDefaultToEmpty, isMapOptionalNullableDefaultToEmpty, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcessEnumVars, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setArrayDefaultToEmpty, setArrayNullableDefaultToEmpty, setArrayOptionalDefaultToEmpty, setArrayOptionalNullableDefaultToEmpty, setAutosetConstants, setCircularReferences, setDefaultToEmptyContainer, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumDiscriminatorDefaultValue, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setMapDefaultToEmpty, setMapNullableDefaultToEmpty, setMapOptionalDefaultToEmpty, setMapOptionalNullableDefaultToEmpty, setModelNamePrefix, setModelNameSuffix, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiFilename, toApiImport, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelImportMap, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, useCodegenAsMustacheParentContext, vendorExtensions, writePropertyBackMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.openapitools.codegen.CodegenConfig
additionalProperties, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTag, getTemplatingEngine, getTypeDeclaration, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcessModelProperty, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiFilename, toApiImport, toBooleanGetter, toGetter, toModelDocFilename, toModelImportMap, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensionsMethods inherited from interface io.micronaut.openapi.generator.MicronautCodeGenerator
optionsBuilder
-
Field Details
-
OPT_TITLE
- See Also:
-
OPT_TEST
- See Also:
-
OPT_TEST_JUNIT
- See Also:
-
OPT_USE_AUTH
- See Also:
-
OPT_GENERATE_ENUM_CONVERTERS
- See Also:
-
OPT_USE_PLURAL
- See Also:
-
OPT_FLUX_FOR_ARRAYS
- See Also:
-
OPT_GENERATED_ANNOTATION
- See Also:
-
OPT_VISITABLE
- See Also:
-
OPT_DATE_LIBRARY_ZONED_DATETIME
- See Also:
-
OPT_DATE_LIBRARY_OFFSET_DATETIME
- See Also:
-
OPT_DATE_LIBRARY_LOCAL_DATETIME
- See Also:
-
OPT_DATE_FORMAT
- See Also:
-
OPT_DATE_TIME_FORMAT
- See Also:
-
OPT_REACTIVE
- See Also:
-
OPT_COROUTINES
- See Also:
-
OPT_JVM_OVERLOADS
- See Also:
-
OPT_JVM_RECORD
- See Also:
-
OPT_JAVA_COMPATIBILITY
- See Also:
-
OPT_GENERATE_HTTP_RESPONSE_ALWAYS
- See Also:
-
OPT_GENERATE_CONTROLLER_AS_ABSTRACT
- See Also:
-
OPT_GENERATE_HTTP_RESPONSE_WHERE_REQUIRED
- See Also:
-
OPT_APPLICATION_NAME
- See Also:
-
OPT_GENERATE_SWAGGER_ANNOTATIONS
- See Also:
-
OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2
- See Also:
-
OPT_GENERATE_SWAGGER_ANNOTATIONS_TRUE
- See Also:
-
OPT_GENERATE_SWAGGER_ANNOTATIONS_FALSE
- See Also:
-
OPT_GENERATE_OPERATION_ONLY_FOR_FIRST_TAG
- See Also:
-
OPT_IMPLICIT_HEADERS
- See Also:
-
OPT_IMPLICIT_HEADERS_REGEX
- See Also:
-
OPT_USE_ENUM_CASE_INSENSITIVE
- See Also:
-
OPT_KSP
- See Also:
-
OPT_USE_TAGS
- See Also:
-
OPT_JSON_INCLUDE_ALWAYS_FOR_REQUIRED_FIELDS
- See Also:
-
ADDITIONAL_ONE_OF_TYPE_ANNOTATIONS
- See Also:
-
ADDITIONAL_ENUM_TYPE_ANNOTATIONS
- See Also:
-
CONTENT_TYPE_APPLICATION_FORM_URLENCODED
- See Also:
-
CONTENT_TYPE_APPLICATION_JSON
- See Also:
-
CONTENT_TYPE_MULTIPART_FORM_DATA
- See Also:
-
CONTENT_TYPE_ANY
- See Also:
-
objectMapper
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper -
random
-
dateLibrary
-
title
-
useBeanValidation
protected boolean useBeanValidation -
visitable
protected boolean visitable -
useTags
protected boolean useTags -
generateEnumConverters
protected boolean generateEnumConverters -
plural
protected boolean plural -
fluxForArrays
protected boolean fluxForArrays -
generatedAnnotation
protected boolean generatedAnnotation -
testTool
-
reactive
protected boolean reactive -
coroutines
protected boolean coroutines -
generateHttpResponseAlways
protected boolean generateHttpResponseAlways -
generateHttpResponseWhereRequired
protected boolean generateHttpResponseWhereRequired -
generateControllerAsAbstract
protected boolean generateControllerAsAbstract -
useEnumCaseInsensitive
protected boolean useEnumCaseInsensitive -
ksp
protected boolean ksp -
jsonIncludeAlwaysForRequiredFields
protected boolean jsonIncludeAlwaysForRequiredFields -
implicitHeaders
protected boolean implicitHeaders -
jvmOverloads
protected boolean jvmOverloads -
jvmRecord
protected boolean jvmRecord -
javaCompatibility
protected boolean javaCompatibility -
implicitHeadersRegex
-
appName
-
dateFormat
-
dateTimeFormat
-
generateSwaggerAnnotations
-
generateOperationOnlyForFirstTag
protected boolean generateOperationOnlyForFirstTag -
serializationLibrary
-
parameterMappings
-
responseBodyMappings
-
allModels
-
additionalOneOfTypeAnnotations
-
additionalEnumTypeAnnotations
-
-
Constructor Details
-
AbstractMicronautKotlinCodegen
protected AbstractMicronautKotlinCodegen()
-
-
Method Details
-
setGenerateHttpResponseAlways
public void setGenerateHttpResponseAlways(boolean generateHttpResponseAlways) -
setGenerateHttpResponseWhereRequired
public void setGenerateHttpResponseWhereRequired(boolean generateHttpResponseWhereRequired) -
setGenerateControllerAsAbstract
public void setGenerateControllerAsAbstract(boolean generateControllerAsAbstract) -
setReactive
public void setReactive(boolean reactive) -
setCoroutines
public void setCoroutines(boolean coroutines) -
setImplicitHeaders
public void setImplicitHeaders(boolean implicitHeaders) -
setImplicitHeadersRegex
-
setTestTool
-
setArtifactId
- Overrides:
setArtifactIdin classorg.openapitools.codegen.languages.AbstractKotlinCodegen
-
setModelPackage
- Overrides:
setModelPackagein classDefaultCodegen
-
setApiPackage
- Overrides:
setApiPackagein classDefaultCodegen
-
setPackageName
- Overrides:
setPackageNamein classorg.openapitools.codegen.languages.AbstractKotlinCodegen
-
setUseTags
public void setUseTags(boolean useTags) -
setGenerateOperationOnlyForFirstTag
public void setGenerateOperationOnlyForFirstTag(boolean generateOperationOnlyForFirstTag) -
setGenerateEnumConverters
public void setGenerateEnumConverters(boolean generateEnumConverters) -
setPlural
public void setPlural(boolean plural) -
setFluxForArrays
public void setFluxForArrays(boolean fluxForArrays) -
setGeneratedAnnotation
public void setGeneratedAnnotation(boolean generatedAnnotation) -
setKsp
public void setKsp(boolean ksp) -
processOpts
public void processOpts()- Specified by:
processOptsin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
processOptsin classorg.openapitools.codegen.languages.AbstractKotlinCodegen
-
addParameterMappings
-
addResponseBodyMappings
-
addSchemaMapping
-
addImportMapping
-
addNameMapping
-
addTypeMapping
-
addEnumNameMapping
-
addModelNameMapping
-
addInlineSchemaNameMapping
-
addInlineSchemaOption
-
addOpenapiNormalizer
-
testFileFolder
-
isServer
public abstract boolean isServer() -
apiTestFileFolder
- Specified by:
apiTestFileFolderin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
apiTestFileFolderin classorg.openapitools.codegen.languages.AbstractKotlinCodegen
-
modelTestFileFolder
- Specified by:
modelTestFileFolderin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
modelTestFileFolderin classorg.openapitools.codegen.languages.AbstractKotlinCodegen
-
toApiTestFilename
Description copied from class:DefaultCodegenReturn the file name of the Api Test- Specified by:
toApiTestFilenamein interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
toApiTestFilenamein classDefaultCodegen- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toModelTestFilename
Description copied from class:DefaultCodegenReturn the capitalized file name of the model test- Specified by:
toModelTestFilenamein interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
toModelTestFilenamein classDefaultCodegen- Parameters:
name- the model name- Returns:
- the file name of the model
-
setUseBeanValidation
public void setUseBeanValidation(boolean useBeanValidation) - Specified by:
setUseBeanValidationin interfaceorg.openapitools.codegen.languages.features.BeanValidationFeatures
-
setVisitable
public void setVisitable(boolean visitable) -
createDiscriminator
protected org.openapitools.codegen.CodegenDiscriminator createDiscriminator(String schemaName, io.swagger.v3.oas.models.media.Schema schema) - Overrides:
createDiscriminatorin classDefaultCodegen
-
toApiVarName
Description copied from class:DefaultCodegenReturn the variable name in the Api- Specified by:
toApiVarNamein interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
toApiVarNamein classDefaultCodegen- Parameters:
name- the variable name of the Api- Returns:
- the snake-cased variable name
-
isVisitable
public boolean isVisitable() -
sanitizeTag
Description copied from class:DefaultCodegenSanitize tag- Specified by:
sanitizeTagin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
sanitizeTagin classDefaultCodegen- Parameters:
tag- Tag- Returns:
- Sanitized tag
-
superSanitizeTag
-
toApiName
Description copied from class:DefaultCodegenOutput the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty- Specified by:
toApiNamein interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
toApiNamein classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
name- the name of the Api- Returns:
- capitalized Api name
-
addOperationToGroup
public void addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, org.openapitools.codegen.CodegenOperation co, Map<String, List<org.openapitools.codegen.CodegenOperation>> operations) Description copied from class:DefaultCodegenAdd operation to group- Specified by:
addOperationToGroupin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
addOperationToGroupin classDefaultCodegen- Parameters:
tag- name of the tagresourcePath- path of the resourceoperation- OAS Operation objectco- Codegen Operation objectoperations- map of Codegen operations
-
preprocessOpenAPI
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openApi) - Specified by:
preprocessOpenAPIin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
preprocessOpenAPIin classDefaultCodegen
-
postProcessOperationsWithModels
public org.openapitools.codegen.model.OperationsMap postProcessOperationsWithModels(org.openapitools.codegen.model.OperationsMap objs, List<org.openapitools.codegen.model.ModelMap> allModels) - Specified by:
postProcessOperationsWithModelsin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
postProcessOperationsWithModelsin classDefaultCodegen
-
handleImplicitHeaders
protected void handleImplicitHeaders(org.openapitools.codegen.CodegenOperation operation) This method removes all implicit header parameters from the list of parameters.- Parameters:
operation- - operation to be processed
-
toEnumValue
Description copied from class:DefaultCodegenReturn the enum value in the language specified format e.g. status becomes "status"- Overrides:
toEnumValuein classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized value for enum
-
fromModel
public org.openapitools.codegen.CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema schema) Description copied from class:DefaultCodegenConvert OAS Model object to Codegen Model object.- Specified by:
fromModelin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
fromModelin classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
name- the name of the modelschema- OAS Model object- Returns:
- Codegen Model object
-
getTypeDeclaration
Output the type declaration of the property.- Specified by:
getTypeDeclarationin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
getTypeDeclarationin classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
p- OpenAPI Property object- Returns:
- a string presentation of the property type
-
getSchemaType
Description copied from class:DefaultCodegenreturns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type- Overrides:
getSchemaTypein classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
p- property schema- Returns:
- string presentation of the type
-
toModelName
Description copied from class:DefaultCodegenConverts the OpenAPI schema name to a model name suitable for the current code generator. May be overridden for each programming language. In case the name belongs to the TypeSystem it won't be renamed.- Specified by:
toModelNamein interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
toModelNamein classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
name- the name of the model- Returns:
- capitalized model name
-
fromRequestBody
public org.openapitools.codegen.CodegenParameter fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports, String bodyParameterName) - Overrides:
fromRequestBodyin classDefaultCodegen
-
fromParameter
public org.openapitools.codegen.CodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter p, Set<String> imports) Description copied from class:DefaultCodegenConvert OAS Parameter object to Codegen Parameter object- Overrides:
fromParameterin classDefaultCodegen- Parameters:
p- OAS parameter objectimports- set of imports for library/package/module- Returns:
- Codegen Parameter object
-
fromResponse
public org.openapitools.codegen.CodegenResponse fromResponse(String responseCode, io.swagger.v3.oas.models.responses.ApiResponse response) Description copied from class:DefaultCodegenConvert OAS Response object to Codegen Response object- Overrides:
fromResponsein classDefaultCodegen- Parameters:
responseCode- HTTP response coderesponse- OAS Response object- Returns:
- Codegen Response object
-
fromRequestBodyToFormParameters
public List<org.openapitools.codegen.CodegenParameter> fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports) - Overrides:
fromRequestBodyToFormParametersin classDefaultCodegen
-
fromProperty
public org.openapitools.codegen.CodegenProperty fromProperty(String name, io.swagger.v3.oas.models.media.Schema schema, boolean required, boolean schemaIsFromAdditionalProperties) Description copied from class:DefaultCodegenConvert OAS Property object to Codegen Property object.The return value is cached. An internal cache is looked up to determine if the CodegenProperty return value has already been instantiated for the (String name, Schema p) arguments. Any subsequent processing of the CodegenModel return value must be idempotent for a given (String name, Schema schema).
- Overrides:
fromPropertyin classDefaultCodegen- Parameters:
name- name of the propertyschema- OAS property schemarequired- true if the property is required in the next higher object schema, false otherwiseschemaIsFromAdditionalProperties- true if the property is a required property defined by additional properties schema If this is the actual additionalProperties schema not defining a required property, then the value should be false- Returns:
- Codegen Property object
-
fromOperation
public org.openapitools.codegen.CodegenOperation fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers) Description copied from class:DefaultCodegenConvert OAS Operation object to Codegen Operation object- Specified by:
fromOperationin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
fromOperationin classDefaultCodegen- Parameters:
path- the path of the operationhttpMethod- HTTP methodoperation- OAS operation objectservers- list of servers- Returns:
- Codegen Operation object
-
toEnumVarName
Description copied from class:DefaultCodegenReturn the sanitized variable name for enum- Overrides:
toEnumVarNamein classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized variable name for enum
-
isNumeric
-
toVarName
Description copied from class:DefaultCodegenReturn the variable name by removing invalid characters and proper escaping if it's a reserved word.- Overrides:
toVarNamein classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
name- the variable name- Returns:
- the sanitized variable name
-
postProcessAllModels
public Map<String,org.openapitools.codegen.model.ModelsMap> postProcessAllModels(Map<String, org.openapitools.codegen.model.ModelsMap> objs) - Specified by:
postProcessAllModelsin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
postProcessAllModelsin classorg.openapitools.codegen.languages.AbstractKotlinCodegen
-
updateEnumVarsWithExtensions
protected void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars, Map<String, Object> vendorExtensions, String dataType) - Overrides:
updateEnumVarsWithExtensionsin classDefaultCodegen
-
setParameterExampleValue
public void setParameterExampleValue(org.openapitools.codegen.CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter) Description copied from class:DefaultCodegenReturn the example value of the parameter.- Overrides:
setParameterExampleValuein classDefaultCodegen- Parameters:
codegenParameter- Codegen parameterparameter- Parameter
-
setParameterExampleValue
public void setParameterExampleValue(org.openapitools.codegen.CodegenParameter p) Description copied from class:DefaultCodegenReturn the example value of the parameter.- Overrides:
setParameterExampleValuein classDefaultCodegen- Parameters:
p- Codegen parameter
-
getParameterExampleValue
-
getPropertyExampleValue
-
getExampleValue
-
toDefaultValue
public String toDefaultValue(org.openapitools.codegen.CodegenProperty cp, io.swagger.v3.oas.models.media.Schema schema) Description copied from class:DefaultCodegenReturn the default value of the propertyReturn null if you do NOT want a default value. Any non-null value will cause {{#defaultValue} check to pass.
- Overrides:
toDefaultValuein classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Parameters:
cp- Codegen propertyschema- Property schema- Returns:
- string presentation of the default value of the property
-
addMustacheLambdas
protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> addMustacheLambdas()Description copied from class:DefaultCodegenPreset map builder with commonly used Mustache lambdas. To extend the map, override addMustacheLambdas(), call parent method first and then add additional lambdas to the returned builder. If common lambdas are not desired, override addMustacheLambdas() method and return empty builder. Corresponding user documentation: docs/templating.md, section "Mustache Lambdas"- Overrides:
addMustacheLambdasin classorg.openapitools.codegen.languages.AbstractKotlinCodegen- Returns:
- preinitialized map with common lambdas
-
getPackageName
-
setSerializationLibrary
-
setDateTimeLibrary
-
setUseOneOfInterfaces
- Overrides:
setUseOneOfInterfacesin classDefaultCodegen
-
getUseInlineModelResolver
public boolean getUseInlineModelResolver()- Specified by:
getUseInlineModelResolverin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
getUseInlineModelResolverin classDefaultCodegen
-
setGenerateSwaggerAnnotations
public void setGenerateSwaggerAnnotations(boolean generateSwaggerAnnotations) -
setJsonIncludeAlwaysForRequiredFields
public void setJsonIncludeAlwaysForRequiredFields(boolean jsonIncludeAlwaysForRequiredFields) -
setDateFormat
-
setDateTimeFormat
-
setUseEnumCaseInsensitive
public void setUseEnumCaseInsensitive(boolean useEnumCaseInsensitive) -
setJvmOverloads
public void setJvmOverloads(boolean jvmOverloads) -
setJvmRecord
public void setJvmRecord(boolean jvmRecord) -
setJavaCompatibility
public void setJavaCompatibility(boolean javaCompatibility) -
setAdditionalOneOfTypeAnnotations
-
setAdditionalEnumTypeAnnotations
-
postProcess
public void postProcess()- Specified by:
postProcessin interfaceorg.openapitools.codegen.CodegenConfig- Overrides:
postProcessin classDefaultCodegen
-