Package io.micronaut.openapi.generator

Class KotlinMicronautClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractKotlinCodegen

io.micronaut.openapi.generator.AbstractMicronautKotlinCodegen<KotlinMicronautClientOptionsBuilder>

io.micronaut.openapi.generator.KotlinMicronautClientCodegen

All Implemented Interfaces:

MicronautCodeGenerator<KotlinMicronautClientOptionsBuilder>, org.openapitools.codegen.CodegenConfig, org.openapitools.codegen.languages.features.BeanValidationFeatures

public class KotlinMicronautClientCodegen
extends AbstractMicronautKotlinCodegen<KotlinMicronautClientOptionsBuilder>

The generator for creating Micronaut clients.

Nested Class Summary

Nested classes/interfaces inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen

org.openapitools.codegen.languages.AbstractKotlinCodegen.DataTypeAssigner

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_CLIENT_TYPE_ANNOTATIONS
protected List<String>	additionalClientTypeAnnotations
static final String	AUTHORIZATION_FILTER_PATTERN
protected String	authorizationFilterPattern
static final String	BASE_PATH_SEPARATOR
protected String	basePathSeparator
static final String	CLIENT_ID
protected String	clientId
protected boolean	clientPath
protected boolean	configureAuthorization
static final String	NAME
static final String	OPT_CLIENT_PATH
static final String	OPT_CONFIGURE_AUTH
static final String	OPT_CONFIGURE_AUTH_FILTER_PATTERN
static final String	OPT_CONFIGURE_CLIENT_ID

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

ADDITIONAL_ENUM_TYPE_ANNOTATIONS, ADDITIONAL_ONE_OF_TYPE_ANNOTATIONS, additionalEnumTypeAnnotations, additionalOneOfTypeAnnotations, allModels, appName, CONTENT_TYPE_ANY, CONTENT_TYPE_APPLICATION_FORM_URLENCODED, CONTENT_TYPE_APPLICATION_JSON, CONTENT_TYPE_MULTIPART_FORM_DATA, dateFormat, dateLibrary, dateTimeFormat, fluxForArrays, generatedAnnotation, generateHttpResponseAlways, generateHttpResponseWhereRequired, generateOperationOnlyForFirstTag, generateSwaggerAnnotations, implicitHeaders, implicitHeadersRegex, ksp, OPT_APPLICATION_NAME, OPT_DATE_FORMAT, OPT_DATE_LIBRARY_LOCAL_DATETIME, OPT_DATE_LIBRARY_OFFSET_DATETIME, OPT_DATE_LIBRARY_ZONED_DATETIME, OPT_DATE_TIME_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_2, OPT_GENERATE_SWAGGER_ANNOTATIONS_TRUE, OPT_GENERATED_ANNOTATION, OPT_IMPLICIT_HEADERS, OPT_IMPLICIT_HEADERS_REGEX, OPT_KSP, OPT_REACTIVE, OPT_REQUIRED_PROPERTIES_IN_CONSTRUCTOR, OPT_TEST, OPT_TEST_JUNIT, OPT_TITLE, OPT_USE_AUTH, OPT_USE_ENUM_CASE_INSENSITIVE, OPT_USE_PLURAL, OPT_VISITABLE, parameterMappings, plural, random, reactive, requiredPropertiesInConstructor, responseBodyMappings, serializationLibrary, testTool, title, useBeanValidation, useEnumCaseInsensitive, visitable

Fields 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, useJakartaEe

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, 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, skipSortingOperations, 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

Method Summary

Modifier and Type	Method	Description
String	getHelp()
String	getName()
org.openapitools.codegen.CodegenType	getTag()
boolean	isServer()
KotlinMicronautClientOptionsBuilder	optionsBuilder()
org.openapitools.codegen.model.OperationsMap	postProcessOperationsWithModels(org.openapitools.codegen.model.OperationsMap objs, List<org.openapitools.codegen.model.ModelMap> allModels)
void	processOpts()
void	setAdditionalClientTypeAnnotations(List<String> additionalClientTypeAnnotations)
void	setAuthorizationFilterPattern(String authorizationFilterPattern)
void	setBasePathSeparator(String basePathSeparator)
void	setClientId(String clientId)
void	setClientPath(boolean clientPath)
void	setConfigureAuthorization(boolean configureAuthorization)

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

addEnumNameMapping, addImportMapping, addInlineSchemaNameMapping, addInlineSchemaOption, addModelNameMapping, addMustacheLambdas, addNameMapping, addOpenapiNormalizer, addOperationToGroup, addParameterMappings, addResponseBodyMappings, addSchemaMapping, addTypeMapping, apiTestFileFolder, createDiscriminator, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, getExampleValue, getPackageName, getParameterExampleValue, getPropertyExampleValue, getTypeDeclaration, getUseInlineModelResolver, handleImplicitHeaders, isNumeric, isVisitable, modelTestFileFolder, postProcess, postProcessAllModels, preprocessOpenAPI, sanitizeTag, setAdditionalEnumTypeAnnotations, setAdditionalOneOfTypeAnnotations, setApiPackage, setArtifactId, setDateFormat, setDateTimeFormat, setDateTimeLibrary, setFluxForArrays, setGeneratedAnnotation, setGenerateHttpResponseAlways, setGenerateHttpResponseWhereRequired, setGenerateSwaggerAnnotations, setImplicitHeaders, setImplicitHeadersRegex, setKsp, setModelPackage, setPackageName, setParameterExampleValue, setParameterExampleValue, setPlural, setReactive, setSerializationLibrary, setTestTool, setUseBeanValidation, setUseEnumCaseInsensitive, setUseOneOfInterfaces, setVisitable, superSanitizeTag, testFileFolder, toApiName, toApiTestFilename, toApiVarName, toDefaultValue, toEnumValue, toEnumVarName, toModelName, toModelTestFilename, toVarName, updateEnumVarsWithExtensions

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

apiDocFileFolder, apiFileFolder, applyJakartaPackage, applyJavaxPackage, doDataTypeAssignment, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, generatorLanguage, getAdditionalModelTypeAnnotations, getEnumPropertyNaming, getParcelizeModels, getSchemaType, 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, updateModelForObject

Methods 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, fromRequestBodyToFormParameters, 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, 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, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isDataTypeBinary, isDataTypeFile, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, 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, setAutosetConstants, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, 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, 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, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, 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, vendorExtensions

Field Details

OPT_CONFIGURE_AUTH

public static final String OPT_CONFIGURE_AUTH

See Also:

• Constant Field Values

OPT_CONFIGURE_AUTH_FILTER_PATTERN

public static final String OPT_CONFIGURE_AUTH_FILTER_PATTERN

See Also:

• Constant Field Values

OPT_CONFIGURE_CLIENT_ID

public static final String OPT_CONFIGURE_CLIENT_ID

See Also:

• Constant Field Values

OPT_CLIENT_PATH

public static final String OPT_CLIENT_PATH

See Also:

• Constant Field Values

ADDITIONAL_CLIENT_TYPE_ANNOTATIONS

public static final String ADDITIONAL_CLIENT_TYPE_ANNOTATIONS

See Also:

• Constant Field Values

AUTHORIZATION_FILTER_PATTERN

public static final String AUTHORIZATION_FILTER_PATTERN

See Also:

• Constant Field Values

BASE_PATH_SEPARATOR

public static final String BASE_PATH_SEPARATOR

See Also:

• Constant Field Values

CLIENT_ID

public static final String CLIENT_ID

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

configureAuthorization

protected boolean configureAuthorization

additionalClientTypeAnnotations

protected List<String> additionalClientTypeAnnotations

authorizationFilterPattern

protected String authorizationFilterPattern

basePathSeparator

protected String basePathSeparator

clientId

protected String clientId

clientPath

protected boolean clientPath

Method Details

getTag

public org.openapitools.codegen.CodegenType getTag()

Specified by:

getTag in interface org.openapitools.codegen.CodegenConfig

Overrides:

getTag in class DefaultCodegen

getName

public String getName()

Specified by:

getName in interface org.openapitools.codegen.CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface org.openapitools.codegen.CodegenConfig

Overrides:

getHelp in class DefaultCodegen

postProcessOperationsWithModels

public org.openapitools.codegen.model.OperationsMap postProcessOperationsWithModels(org.openapitools.codegen.model.OperationsMap objs,
 List<org.openapitools.codegen.model.ModelMap> allModels)

Specified by:

postProcessOperationsWithModels in interface org.openapitools.codegen.CodegenConfig

Overrides:

postProcessOperationsWithModels in class AbstractMicronautKotlinCodegen<KotlinMicronautClientOptionsBuilder>

processOpts

public void processOpts()

Specified by:

processOpts in interface org.openapitools.codegen.CodegenConfig

Overrides:

processOpts in class AbstractMicronautKotlinCodegen<KotlinMicronautClientOptionsBuilder>

isServer

public boolean isServer()

Specified by:

isServer in class AbstractMicronautKotlinCodegen<KotlinMicronautClientOptionsBuilder>

setAdditionalClientTypeAnnotations

public void setAdditionalClientTypeAnnotations(List<String> additionalClientTypeAnnotations)

setAuthorizationFilterPattern

public void setAuthorizationFilterPattern(String authorizationFilterPattern)

setClientId

public void setClientId(String clientId)

setClientPath

public void setClientPath(boolean clientPath)

setBasePathSeparator

public void setBasePathSeparator(String basePathSeparator)

setConfigureAuthorization

public void setConfigureAuthorization(boolean configureAuthorization)

optionsBuilder

public KotlinMicronautClientOptionsBuilder optionsBuilder()