org.openapitools.codegen.languages

Class GoClientExperimentalCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractGoCodegen

org.openapitools.codegen.languages.GoClientCodegen

org.openapitools.codegen.languages.GoClientExperimentalCodegen

All Implemented Interfaces:

CodegenConfig

public class GoClientExperimentalCodegen
extends GoClientCodegen

Field Summary

Fields

Modifier and Type	Field and Description
protected String	goImportAlias

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

apiDocPath, isGoSubmodule, modelDocPath, packageVersion, STRUCT_PREFIX, WITH_AWSV4_SIGNATURE, WITH_GO_CODEGEN_COMMENT, WITH_XML

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

enumClassPrefix, numberTypes, packageName, structPrefix, usesOptionals, withAWSV4Signature, withGoCodegenComment, withXml

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, DefaultFeatureSet, defaultIncludes, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
GoClientExperimentalCodegen()

Method Summary

Modifier and Type	Method and Description
void	addImportsToOneOfInterface(List<Map<String,String>> imports)
String	escapeReservedWord(String name) Escapes a reserved word as defined in the `reservedWords` array.
CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema p) Convert OAS Property object to Codegen Property object
String	getHelp() Returns human-friendly help for the generator.
String	getName() Configures a friendly name for the generator.
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	processOpts()
void	setGoImportAlias(String goImportAlias)
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema p) Return the default value of the property
String	toEnumDefaultValue(String value, String datatype) Return the enum default value in the language specified format
String	toGetter(String name) Output the Getter name, e.g.
String	toModelName(String name) Output the proper model name (capitalized).
void	updateCodegenPropertyEnum(CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)

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

apiDocFileFolder, apiFileFolder, getTag, modelDocFileFolder, modelFileFolder, setIsGoSubmodule, setPackageVersion, toApiDocFilename, toModelDocFilename

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

createMapping, escapeQuotationMark, escapeUnsafeCharacters, getSchemaType, getTypeDeclaration, isNumberType, isReservedFilename, isReservedWord, needToImport, postProcessFile, postProcessModelProperty, postProcessSupportingFileData, setEnumClassPrefix, setPackageName, setStructPrefix, setWithAWSV4Signature, setWithGoCodegenComment, setWithXml, toApiFilename, toEnumName, toEnumValue, toEnumVarName, toInstantiationType, toModel, toModel, toModelFilename, toOperationId, toParamName, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addHeaders, addImport, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getEnsureUniqueParams, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaAdditionalProperties, getSchemaItems, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseOneOfInterfaces, handleMethodResponse, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setCommonTemplateDir, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toModelImport, toModelTestFilename, toOneOfName, toRegularExpression, toSetter, typeMapping, updateAllModels, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateOption, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, 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, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

goImportAlias

protected String goImportAlias

Constructor Detail

GoClientExperimentalCodegen

public GoClientExperimentalCodegen()

Method Detail

getName

public String getName()

Configures a friendly name for the generator. This will be used by the generator to select the library with the -g flag.

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class GoClientCodegen

Returns:

the friendly name for the generator

toGetter

public String toGetter(String name)

Description copied from class: DefaultCodegen

Output the Getter name, e.g. getSize

Specified by:

toGetter in interface CodegenConfig

Overrides:

toGetter in class DefaultCodegen

Parameters:

name - the name of the property

Returns:

getter name based on naming convention

getHelp

public String getHelp()

Returns human-friendly help for the generator. Provide the consumer with help tips, parameters here

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class GoClientCodegen

Returns:

A string value for the help message

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class GoClientCodegen

setGoImportAlias

public void setGoImportAlias(String goImportAlias)

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class AbstractGoCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: AbstractGoCodegen

Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reserved words

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class AbstractGoCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped term

toEnumDefaultValue

public String toEnumDefaultValue(String value,
                                 String datatype)

Description copied from class: DefaultCodegen

Return the enum default value in the language specified format

Overrides:

toEnumDefaultValue in class AbstractGoCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the default value for the enum

updateCodegenPropertyEnum

public void updateCodegenPropertyEnum(CodegenProperty var)

Description copied from class: DefaultCodegen

Update codegen property's enum by adding "enumVars" (with name and value)

Overrides:

updateCodegenPropertyEnum in class DefaultCodegen

Parameters:

var - list of CodegenProperty

toDefaultValue

public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

Return the default value of the property

Overrides:

toDefaultValue in class AbstractGoCodegen

Parameters:

p - Property schema

Returns:

string presentation of the default value of the property

fromProperty

public CodegenProperty fromProperty(String name,
                                    io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

Convert OAS Property object to Codegen Property object

Overrides:

fromProperty in class DefaultCodegen

Parameters:

name - name of the property

p - OAS property schema

Returns:

Codegen Property object

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractGoCodegen

addImportsToOneOfInterface

public void addImportsToOneOfInterface(List<Map<String,String>> imports)

Overrides:

addImportsToOneOfInterface in class DefaultCodegen

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class AbstractGoCodegen