io.swagger.codegen.languages

Class JavascriptClientCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.JavascriptClientCodegen

All Implemented Interfaces:

CodegenConfig

public class JavascriptClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiDocPath
protected String	apiTestPath
static String	EMIT_JS_DOC
static String	EMIT_MODEL_METHODS
protected boolean	emitJSDoc
protected boolean	emitModelMethods
protected String	invokerPackage
protected String	localVariablePrefix
protected String	modelDocPath
protected String	modelTestPath
static String	MODULE_NAME
protected String	moduleName
static String	PROJECT_DESCRIPTION
static String	PROJECT_LICENSE_NAME
static String	PROJECT_NAME
static String	PROJECT_VERSION
protected String	projectDescription
protected String	projectLicenseName
protected String	projectName
protected String	projectVersion
protected String	sourceFolder
static String	USE_INHERITANCE
static String	USE_PROMISES
protected boolean	usePromises

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, httpUserAgent, importMapping, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, reservedWords, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, templateDir, testPackage, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
JavascriptClientCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
String	apiDocFileFolder()
String	apiFileFolder()
String	apiTestFileFolder()
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name) Return the escaped name of the reserved word
String	escapeUnsafeCharacters(String input) override with any special text escaping logic to handle unsafe characters so as to avoid code injection
CodegenModel	fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions) Convert Swagger Model object to Codegen Model object
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions, io.swagger.models.Swagger swagger) Convert Swagger Operation object to Codegen Operation object
String	getHelp()
String	getName()
String	getSwaggerType(io.swagger.models.properties.Property p) returns the swagger type for the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.models.properties.Property p) Output the type declaration of the property
String	modelDocFileFolder()
String	modelFileFolder()
String	modelTestFileFolder()
protected boolean	needToImport(String type) Check the type to see if it needs import the library/module/package
String	normalizeType(String type) Normalize type by wrapping primitive types with single quotes.
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
void	preprocessSwagger(io.swagger.models.Swagger swagger)
void	processOpts()
void	setEmitJSDoc(boolean emitJSDoc)
void	setEmitModelMethods(boolean emitModelMethods)
void	setInvokerPackage(String invokerPackage)
void	setLocalVariablePrefix(String localVariablePrefix)
void	setModuleName(String moduleName)
void	setParameterExampleValue(CodegenParameter p) Return the example value of the parameter.
void	setProjectDescription(String projectDescription)
void	setProjectLicenseName(String projectLicenseName)
void	setProjectName(String projectName)
void	setProjectVersion(String projectVersion)
void	setSourceFolder(String sourceFolder)
void	setUseInheritance(boolean useInheritance)
void	setUsePromises(boolean usePromises)
String	toApiDocFilename(String name) Return the file name of the Api Documentation
String	toApiImport(String name) Return the fully-qualified "Api" name for import
String	toApiTestFilename(String name) Return the file name of the Api Test
String	toDefaultValue(io.swagger.models.properties.Property p) Return the default value of the property
String	toDefaultValueWithParam(String name, io.swagger.models.properties.Property p) Return the property initialized from a data object Useful for initialization with a plain object in Javascript
String	toEnumName(CodegenProperty property) Return the Enum name (e.g.
String	toEnumValue(String value, String datatype) Return the enum value in the language specifed format e.g.
String	toEnumVarName(String value, String datatype) Return the sanitized variable name for enum
String	toModelDocFilename(String name) Return the capitalized file name of the model documentation
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelImport(String name) Return the fully-qualified "Model" name for import
String	toModelName(String name) Output the proper model name (capitalized)
String	toModelTestFilename(String name) Return the capitalized file name of the model test
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.

Methods inherited from class io.swagger.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addProperties, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getLibrary, getOrGenerateOperationId, getOutputDir, getReleaseNote, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isPropertyInnerMostEnum, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, sanitizeName, sanitizeTag, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHttpUserAgent, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiName, toApiVarName, toEnumDefaultValue, toExamples, toExampleValue, toInstantiationType, toRegularExpression, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

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

additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessParameter, postProcessSupportingFileData, processSwagger, reservedWords, sanitizeTag, setGitRepoId, setGitUserId, setHttpUserAgent, setLibrary, setOutputDir, setReleaseNote, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiName, toApiVarName, typeMapping, vendorExtensions

Field Detail

PROJECT_NAME

public static final String PROJECT_NAME

See Also:

Constant Field Values

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

PROJECT_DESCRIPTION

public static final String PROJECT_DESCRIPTION

See Also:

Constant Field Values

PROJECT_VERSION

public static final String PROJECT_VERSION

See Also:

Constant Field Values

PROJECT_LICENSE_NAME

public static final String PROJECT_LICENSE_NAME

See Also:

Constant Field Values

USE_PROMISES

public static final String USE_PROMISES

See Also:

Constant Field Values

USE_INHERITANCE

public static final String USE_INHERITANCE

See Also:

Constant Field Values

EMIT_MODEL_METHODS

public static final String EMIT_MODEL_METHODS

See Also:

Constant Field Values

EMIT_JS_DOC

public static final String EMIT_JS_DOC

See Also:

Constant Field Values

projectName

protected String projectName

moduleName

protected String moduleName

projectDescription

protected String projectDescription

projectVersion

protected String projectVersion

projectLicenseName

protected String projectLicenseName

invokerPackage

protected String invokerPackage

sourceFolder

protected String sourceFolder

localVariablePrefix

protected String localVariablePrefix

usePromises

protected boolean usePromises

emitModelMethods

protected boolean emitModelMethods

emitJSDoc

protected boolean emitJSDoc

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

apiTestPath

protected String apiTestPath

modelTestPath

protected String modelTestPath

Constructor Detail

JavascriptClientCodegen

public JavascriptClientCodegen()

Method Detail

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

getName

public String getName()

Specified by:

getName in interface CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

preprocessSwagger

public void preprocessSwagger(io.swagger.models.Swagger swagger)

Specified by:

preprocessSwagger in interface CodegenConfig

Overrides:

preprocessSwagger in class DefaultCodegen

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word throws Runtime exception as reserved word is not allowed (default behavior)

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface CodegenConfig

Overrides:

apiTestFileFolder in class DefaultCodegen

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

modelTestFileFolder in interface CodegenConfig

Overrides:

modelTestFileFolder in class DefaultCodegen

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

setInvokerPackage

public void setInvokerPackage(String invokerPackage)

setSourceFolder

public void setSourceFolder(String sourceFolder)

setProjectName

public void setProjectName(String projectName)

setLocalVariablePrefix

public void setLocalVariablePrefix(String localVariablePrefix)

setModuleName

public void setModuleName(String moduleName)

setProjectDescription

public void setProjectDescription(String projectDescription)

setProjectVersion

public void setProjectVersion(String projectVersion)

setProjectLicenseName

public void setProjectLicenseName(String projectLicenseName)

setUsePromises

public void setUsePromises(boolean usePromises)

setUseInheritance

public void setUseInheritance(boolean useInheritance)

setEmitModelMethods

public void setEmitModelMethods(boolean emitModelMethods)

setEmitJSDoc

public void setEmitJSDoc(boolean emitJSDoc)

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

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

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

toApiTestFilename

public String toApiTestFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface CodegenConfig

Overrides:

toApiTestFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toModelTestFilename

public String toModelTestFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model test

Specified by:

toModelTestFilename in interface CodegenConfig

Overrides:

toModelTestFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegen

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

Overrides:

toVarName in class DefaultCodegen

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegen

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

Specified by:

toParamName in interface CodegenConfig

Overrides:

toParamName in class DefaultCodegen

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

Output the proper model name (capitalized)

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toModelImport

public String toModelImport(String name)

Description copied from class: DefaultCodegen

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface CodegenConfig

Overrides:

toModelImport in class DefaultCodegen

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

toApiImport

public String toApiImport(String name)

Description copied from class: DefaultCodegen

Return the fully-qualified "Api" name for import

Specified by:

toApiImport in interface CodegenConfig

Overrides:

toApiImport in class DefaultCodegen

Parameters:

name - the name of the "Api"

Returns:

the fully-qualified "Api" name for import

getTypeDeclaration

public String getTypeDeclaration(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

p - Swagger Property object

Returns:

a string presentation of the property type

toDefaultValue

public String toDefaultValue(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the default value of the property

toDefaultValueWithParam

public String toDefaultValueWithParam(String name,
                             io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Return the property initialized from a data object Useful for initialization with a plain object in Javascript

Overrides:

toDefaultValueWithParam in class DefaultCodegen

Parameters:

name - Name of the property object

p - Swagger property object

Returns:

string presentation of the default value of the property

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

normalizeType

public String normalizeType(String type)

Normalize type by wrapping primitive types with single quotes.

Parameters:

type - Primitive type

Returns:

Normalized type

getSwaggerType

public String getSwaggerType(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

returns the swagger type for the property

Overrides:

getSwaggerType in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the type

toOperationId

public String toOperationId(String operationId)

Description copied from class: DefaultCodegen

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegen

Parameters:

operationId - operation ID

Returns:

the sanitized method name

fromOperation

public CodegenOperation fromOperation(String path,
                             String httpMethod,
                             io.swagger.models.Operation operation,
                             Map<String,io.swagger.models.Model> definitions,
                             io.swagger.models.Swagger swagger)

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

definitions - a map of Swagger models

swagger - a Swagger object representing the spec

Returns:

Codegen Operation object

fromModel

public CodegenModel fromModel(String name,
                     io.swagger.models.Model model,
                     Map<String,io.swagger.models.Model> allDefinitions)

Description copied from class: DefaultCodegen

Convert Swagger Model object to Codegen Model object

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class DefaultCodegen

Parameters:

name - the name of the model

model - Swagger Model object

allDefinitions - a map of all Swagger models from the spec

Returns:

Codegen Model object

postProcessOperations

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

Specified by:

postProcessOperations in interface CodegenConfig

Overrides:

postProcessOperations in class DefaultCodegen

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

needToImport

protected boolean needToImport(String type)

Description copied from class: DefaultCodegen

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

Overrides:

needToImport in class DefaultCodegen

Parameters:

type - name of the type

Returns:

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

toEnumName

public String toEnumName(CodegenProperty property)

Description copied from class: DefaultCodegen

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

Overrides:

toEnumName in class DefaultCodegen

Parameters:

property - Codegen property

Returns:

the Enum name

toEnumVarName

public String toEnumVarName(String value,
                   String datatype)

Description copied from class: DefaultCodegen

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

toEnumValue

public String toEnumValue(String value,
                 String datatype)

Description copied from class: DefaultCodegen

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

Overrides:

toEnumValue in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

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)

Description copied from class: DefaultCodegen

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