io.swagger.codegen.languages

Class BashClientCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.BashClientCodegen

All Implemented Interfaces:

CodegenConfig

public class BashClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiDocPath
static String	APIKEY_AUTH_ENVIRONMENT_VARIABLE_NAME
protected String	apiKeyAuthEnvironmentVariable
protected String	apiVersion
static String	BASIC_AUTH_ENVIRONMENT_VARIABLE_NAME
protected String	basicAuthEnvironmentVariable
static String	CURL_OPTIONS
protected String	curlOptions
static String	GENERATE_BASH_COMPLETION
static String	GENERATE_ZSH_COMPLETION
protected boolean	generateBashCompletion
protected boolean	generateZshCompletion
static String	HOST_ENVIRONMENT_VARIABLE_NAME
protected String	hostEnvironmentVariable
protected String	modelDocPath
static String	PROCESS_MARKDOWN
protected boolean	processMarkdown
static String	SCRIPT_NAME
protected String	scriptName

Fields inherited from class io.swagger.codegen.DefaultCodegen

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

Constructor Summary

Constructors

Constructor and Description
BashClientCodegen()

Method Summary

Modifier and Type	Method and Description
String	apiDocFileFolder()
String	apiFileFolder() Location to write api files.
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	escapeText(String input) Override with any special text escaping logic
String	escapeUnsafeCharacters(String input) Override with any special text escaping logic to handle unsafe characters so as to avoid code injection.
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	getHelp() Returns human-friendly help for the generator.
String	getName() Configures a friendly name for the generator.
String	getSchemaType(io.swagger.v3.oas.models.media.Schema propertySchema) Optional - swagger type conversion.
CodegenType	getTag() Configures the type of generator.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema) Optional - type declaration.
String	modelDocFileFolder()
String	modelFileFolder() Location to write model files.
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) Preprocess original properties from the Swagger definition where necessary.
void	processOpts()
void	setApiKeyAuthEnvironmentVariable(String apiKeyAuthEnvironmentVariable)
void	setBasicAuthEnvironmentVariable(String basicAuthEnvironmentVariable)
void	setCurlOptions(String curlOptions)
void	setGenerateBashCompletion(boolean generateBashCompletion)
void	setGenerateZshCompletion(boolean generateZshCompletion)
void	setHostEnvironmentVariable(String hostEnvironmentVariable)
void	setParameterExampleValue(CodegenParameter p) Return the example value of the parameter.
void	setProcessMarkdown(boolean processMarkdown)
void	setScriptName(String scriptName)
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.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationToGroup, addProducesInfo, addProperties, addRegularExpressionDelimiter, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, detectParent, embeddedTemplateDir, fileSuffix, findMethodResponse, fromModel, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromResponse, getSimpleRef, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toInstantiationType, toModelFilename, toModelImport, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toSetter, toVarName, typeMapping, underscore, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, 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 io.swagger.codegen.CodegenConfig

addHandlebarHelpers, additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, fileSuffix, fromModel, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeTag, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelFilename, toModelImport, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

Field Detail

apiVersion

protected String apiVersion

curlOptions

protected String curlOptions

processMarkdown

protected boolean processMarkdown

scriptName

protected String scriptName

generateBashCompletion

protected boolean generateBashCompletion

generateZshCompletion

protected boolean generateZshCompletion

hostEnvironmentVariable

protected String hostEnvironmentVariable

basicAuthEnvironmentVariable

protected String basicAuthEnvironmentVariable

apiKeyAuthEnvironmentVariable

protected String apiKeyAuthEnvironmentVariable

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

CURL_OPTIONS

public static final String CURL_OPTIONS

See Also:

Constant Field Values

PROCESS_MARKDOWN

public static final String PROCESS_MARKDOWN

See Also:

Constant Field Values

SCRIPT_NAME

public static final String SCRIPT_NAME

See Also:

Constant Field Values

GENERATE_BASH_COMPLETION

public static final String GENERATE_BASH_COMPLETION

See Also:

Constant Field Values

GENERATE_ZSH_COMPLETION

public static final String GENERATE_ZSH_COMPLETION

See Also:

Constant Field Values

HOST_ENVIRONMENT_VARIABLE_NAME

public static final String HOST_ENVIRONMENT_VARIABLE_NAME

See Also:

Constant Field Values

BASIC_AUTH_ENVIRONMENT_VARIABLE_NAME

public static final String BASIC_AUTH_ENVIRONMENT_VARIABLE_NAME

See Also:

Constant Field Values

APIKEY_AUTH_ENVIRONMENT_VARIABLE_NAME

public static final String APIKEY_AUTH_ENVIRONMENT_VARIABLE_NAME

See Also:

Constant Field Values

Constructor Detail

BashClientCodegen

public BashClientCodegen()

Method Detail

getTag

public CodegenType getTag()

Configures the type of generator.

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

Returns:

the CodegenType for this generator

See Also:

CodegenType

getName

public String getName()

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

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

Returns:

the friendly name for the generator

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 DefaultCodegen

Returns:

A string value for the help message

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

setCurlOptions

public void setCurlOptions(String curlOptions)

setProcessMarkdown

public void setProcessMarkdown(boolean processMarkdown)

setScriptName

public void setScriptName(String scriptName)

setGenerateBashCompletion

public void setGenerateBashCompletion(boolean generateBashCompletion)

setGenerateZshCompletion

public void setGenerateZshCompletion(boolean generateZshCompletion)

setHostEnvironmentVariable

public void setHostEnvironmentVariable(String hostEnvironmentVariable)

setBasicAuthEnvironmentVariable

public void setBasicAuthEnvironmentVariable(String basicAuthEnvironmentVariable)

setApiKeyAuthEnvironmentVariable

public void setApiKeyAuthEnvironmentVariable(String apiKeyAuthEnvironmentVariable)

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.

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped term

modelFileFolder

public String modelFileFolder()

Location to write model files. You can use the modelPackage() as defined when the class is instantiated.

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

apiFileFolder

public String apiFileFolder()

Location to write api files. You can use the apiPackage() as defined when the class is instantiated.

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegen

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegen

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toApiDocFilename

public String toApiDocFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Documentation

Specified by:

toApiDocFilename in interface CodegenConfig

Overrides:

toApiDocFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

getTypeDeclaration

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

Optional - type declaration. This is a String which is used by the templates to instantiate your types. There is typically special handling for different property types

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

propertySchema - Schema Property object

Returns:

a string value used as the `dataType` field for model templates, `returnType` for api templates

getSchemaType

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

Optional - swagger type conversion. This is used to map swagger types in a `Property` into either language specific types via `typeMapping` or into complex models if there is not a mapping.

Overrides:

getSchemaType in class DefaultCodegen

Parameters:

propertySchema - Schema property object

Returns:

a string value of the type or complex model for this property

See Also:

Schema

escapeText

public String escapeText(String input)

Override with any special text escaping logic

Specified by:

escapeText in interface CodegenConfig

Overrides:

escapeText in class DefaultCodegen

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegen

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

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

Specified by:

escapeUnsafeCharacters in interface CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

fromOperation

public 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: DefaultCodegen

Convert Swagger Operation object to Codegen Operation object

Specified by:

fromOperation in interface CodegenConfig

Overrides:

fromOperation in class DefaultCodegen

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

preprocessOpenAPI

public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Preprocess original properties from the Swagger definition where necessary.

Specified by:

preprocessOpenAPI in interface CodegenConfig

Overrides:

preprocessOpenAPI in class DefaultCodegen

Parameters:

openAPI - [description]

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter p)

Description copied from class: DefaultCodegen

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class DefaultCodegen

Parameters:

p - Swagger property object