org.openapitools.codegen.languages

类 AbstractGoCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractGoCodegen

所有已实现的接口:

CodegenConfig

直接已知子类:

GoClientCodegen, GoGinServerCodegen, GoServerCodegen

public abstract class AbstractGoCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段

限定符和类型	字段和说明
protected String	packageName
protected boolean	withGoCodegenComment
protected boolean	withXml

从类继承的字段 org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enablePostProcessFile, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, globalOpenAPI, globalSchemas, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

构造器概要

构造器

构造器和说明
AbstractGoCodegen()

方法概要

限定符和类型	方法和说明
Map<String,String>	createMapping(String key, String value)
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name) Escapes a reserved word as defined in the `reservedWords` array.
String	escapeUnsafeCharacters(String input) override with any special text escaping logic to handle unsafe characters so as to avoid code injection
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) returns the OpenAPI type for the property.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
protected boolean	isReservedWord(String word)
protected boolean	needToImport(String type) Check the type to see if it needs import the library/module/package
void	postProcessFile(File file, String fileType) Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	processOpts()
void	setPackageName(String packageName)
void	setWithGoCodegenComment(boolean withGoCodegenComment)
void	setWithXml(boolean withXml)
String	toApiFilename(String name) Return the file name of the Api Test
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema schema) Return the default value of the property
String	toEnumDefaultValue(String value, String datatype) Return the enum default value in the language specified format
String	toEnumName(CodegenProperty property) Return the Enum name (e.g.
String	toEnumValue(String value, String datatype) Return the enum value in the language specified format e.g. status becomes "status"
String	toEnumVarName(String name, String datatype) Return the sanitized variable name for enum
String	toModel(String name)
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelName(String name) Output the proper model name (capitalized).
String	toOperationId(String operationId) Return the operation ID (method name)
String	toParamName(String name) Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
String	toVarName(String name) Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

从类继承的方法 org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getName, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getTag, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, toRegularExpression, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTag, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessOperations, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

字段详细资料

withGoCodegenComment

protected boolean withGoCodegenComment

withXml

protected boolean withXml

packageName

protected String packageName

构造器详细资料

AbstractGoCodegen

public AbstractGoCodegen()

方法详细资料

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 DefaultCodegen

escapeReservedWord

public String escapeReservedWord(String name)

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

指定者:

escapeReservedWord 在接口中 CodegenConfig

覆盖:

escapeReservedWord 在类中 DefaultCodegen

参数:

name - the name to be escaped

返回:

the escaped term

toVarName

public String toVarName(String name)

从类复制的说明: DefaultCodegen

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

覆盖:

toVarName 在类中 DefaultCodegen

参数:

name - the variable name

返回:

the sanitized variable name

isReservedWord

protected boolean isReservedWord(String word)

覆盖:

isReservedWord 在类中 DefaultCodegen

toParamName

public String toParamName(String name)

从类复制的说明: DefaultCodegen

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

指定者:

toParamName 在接口中 CodegenConfig

覆盖:

toParamName 在类中 DefaultCodegen

参数:

name - Codegen property object

返回:

the sanitized parameter name

toModelName

public String toModelName(String name)

从类复制的说明: DefaultCodegen

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

指定者:

toModelName 在接口中 CodegenConfig

覆盖:

toModelName 在类中 DefaultCodegen

参数:

name - the name of the model

返回:

capitalized model name

toModelFilename

public String toModelFilename(String name)

从类复制的说明: DefaultCodegen

Return the capitalized file name of the model

指定者:

toModelFilename 在接口中 CodegenConfig

覆盖:

toModelFilename 在类中 DefaultCodegen

参数:

name - the model name

返回:

the file name of the model

toModel

public String toModel(String name)

toApiFilename

public String toApiFilename(String name)

从类复制的说明: DefaultCodegen

Return the file name of the Api Test

指定者:

toApiFilename 在接口中 CodegenConfig

覆盖:

toApiFilename 在类中 DefaultCodegen

参数:

name - the file name of the Api

返回:

the file name of the Api

getTypeDeclaration

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

从类复制的说明: DefaultCodegen

Output the type declaration of the property

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 DefaultCodegen

参数:

p - property schema

返回:

a string presentation of the property type

getSchemaType

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

从类复制的说明: DefaultCodegen

returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type

覆盖:

getSchemaType 在类中 DefaultCodegen

参数:

p - property schema

返回:

string presentation of the type

toOperationId

public String toOperationId(String operationId)

从类复制的说明: DefaultCodegen

Return the operation ID (method name)

覆盖:

toOperationId 在类中 DefaultCodegen

参数:

operationId - operation ID

返回:

the sanitized method name

postProcessOperationsWithModels

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

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 DefaultCodegen

postProcessModels

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

指定者:

postProcessModels 在接口中 CodegenConfig

覆盖:

postProcessModels 在类中 DefaultCodegen

postProcessSupportingFileData

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

指定者:

postProcessSupportingFileData 在接口中 CodegenConfig

覆盖:

postProcessSupportingFileData 在类中 DefaultCodegen

needToImport

protected boolean needToImport(String type)

从类复制的说明: DefaultCodegen

Check the type to see if it needs import the library/module/package

覆盖:

needToImport 在类中 DefaultCodegen

参数:

type - name of the type

返回:

true if the library/module/package of the corresponding type needs to be imported

setPackageName

public void setPackageName(String packageName)

escapeQuotationMark

public String escapeQuotationMark(String input)

从类复制的说明: DefaultCodegen

Escape single and/or double quote to avoid code injection

指定者:

escapeQuotationMark 在接口中 CodegenConfig

覆盖:

escapeQuotationMark 在类中 DefaultCodegen

参数:

input - String to be cleaned up

返回:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

从类复制的说明: DefaultCodegen

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

指定者:

escapeUnsafeCharacters 在接口中 CodegenConfig

覆盖:

escapeUnsafeCharacters 在类中 DefaultCodegen

参数:

input - String to be cleaned up

返回:

string with unsafe characters removed or escaped

createMapping

public Map<String,String> createMapping(String key,
                                        String value)

toEnumValue

public String toEnumValue(String value,
                          String datatype)

从类复制的说明: DefaultCodegen

Return the enum value in the language specified format e.g. status becomes "status"

覆盖:

toEnumValue 在类中 DefaultCodegen

参数:

value - enum variable name

datatype - data type

返回:

the sanitized value for enum

toEnumDefaultValue

public String toEnumDefaultValue(String value,
                                 String datatype)

从类复制的说明: DefaultCodegen

Return the enum default value in the language specified format

覆盖:

toEnumDefaultValue 在类中 DefaultCodegen

参数:

value - enum variable name

datatype - data type

返回:

the default value for the enum

toEnumVarName

public String toEnumVarName(String name,
                            String datatype)

从类复制的说明: DefaultCodegen

Return the sanitized variable name for enum

覆盖:

toEnumVarName 在类中 DefaultCodegen

参数:

name - enum variable name

datatype - data type

返回:

the sanitized variable name for enum

toEnumName

public String toEnumName(CodegenProperty property)

从类复制的说明: DefaultCodegen

Return the Enum name (e.g. StatusEnum given 'status')

覆盖:

toEnumName 在类中 DefaultCodegen

参数:

property - Codegen property

返回:

the Enum name

setWithGoCodegenComment

public void setWithGoCodegenComment(boolean withGoCodegenComment)

setWithXml

public void setWithXml(boolean withXml)

toDefaultValue

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

从类复制的说明: DefaultCodegen

Return the default value of the property

覆盖:

toDefaultValue 在类中 DefaultCodegen

参数:

schema - Property schema

返回:

string presentation of the default value of the property

postProcessFile

public void postProcessFile(File file,
                            String fileType)

从类复制的说明: DefaultCodegen

Post-process the auto-generated file, e.g. using go-fmt to format the Go code. The file type can be "model-test", "model-doc", "model", "api", "api-test", "api-doc", "supporting-mustache", "supporting-common", "openapi-generator-ignore", "openapi-generator-version"

TODO: store these values in enum instead

指定者:

postProcessFile 在接口中 CodegenConfig

覆盖:

postProcessFile 在类中 DefaultCodegen

参数:

file - file to be processed

fileType - file type