Package io.swagger.codegen.v3.generators.go

Class GoClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.go.AbstractGoCodegen

io.swagger.codegen.v3.generators.go.GoClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class GoClientCodegen
extends AbstractGoCodegen

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiDocPath
protected String	modelDocPath
protected String	packageVersion
static final String	WITH_XML

Fields inherited from class io.swagger.codegen.v3.generators.go.AbstractGoCodegen

LOGGER, packageName, withXml

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors

Constructor	Description
GoClientCodegen()

Method Summary

Modifier and Type	Method	Description
String	apiDocFileFolder()
String	apiFileFolder()
io.swagger.codegen.v3.CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> schemas, io.swagger.v3.oas.models.OpenAPI openAPI)	Convert Swagger Operation object to Codegen Operation object
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
io.swagger.codegen.v3.CodegenType	getTag()
String	modelDocFileFolder()
String	modelFileFolder()
void	processOpts()
void	setPackageVersion(String packageVersion)
String	toApiDocFilename(String name)	Return the file name of the Api Documentation
String	toModelDocFilename(String name)	Return the capitalized file name of the model documentation

Methods inherited from class io.swagger.codegen.v3.generators.go.AbstractGoCodegen

checkAliasModel, createMapping, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromModel, getSchemaHandler, getSchemaType, getTypeDeclaration, needToImport, postProcessModels, postProcessOperations, postProcessParameter, postProcessSupportingFileData, setPackageName, setWithXml, toApiFilename, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModel, toModelFilename, toModelName, toOperationId, toParamName, toVarName

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, preprocessOpenAPI, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

getCodeName, getPriority, isPrivileged

Field Details

packageVersion

protected String packageVersion

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

WITH_XML

public static final String WITH_XML

See Also:

• Constant Field Values

Constructor Details

GoClientCodegen

public GoClientCodegen()

Method Details

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class DefaultCodegenConfig

getTag

public io.swagger.codegen.v3.CodegenType getTag()

getName

public String getName()

getHelp

public String getHelp()

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegenConfig

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegenConfig

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegenConfig

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegenConfig

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toApiDocFilename

public String toApiDocFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Documentation

Specified by:

toApiDocFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiDocFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

setPackageVersion

public void setPackageVersion(String packageVersion)

fromOperation

public io.swagger.codegen.v3.CodegenOperation fromOperation(String path,
 String httpMethod,
 io.swagger.v3.oas.models.Operation operation,
 Map<String,io.swagger.v3.oas.models.media.Schema> schemas,
 io.swagger.v3.oas.models.OpenAPI openAPI)

Description copied from class: DefaultCodegenConfig

Convert Swagger Operation object to Codegen Operation object

Specified by:

fromOperation in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

fromOperation in class DefaultCodegenConfig

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - Swagger operation object

schemas - a map of schemas

openAPI - a OpenAPI object representing the spec

Returns:

Codegen Operation object