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	localVariablePrefix
protected String	moduleName
protected String	projectDescription
protected String	projectName
protected String	projectVersion
protected String	sourceFolder

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, importMapping, instantiationTypes, languageSpecificPrimitives, library, modelPackage, modelTemplateFiles, outputFolder, reservedWords, skipOverwrite, sortParamsByRequiredFlag, supportedLibraries, supportingFiles, supportsInheritance, templateDir, typeMapping

Constructor Summary

Constructors

Constructor and Description
JavascriptClientCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
String	apiFileFolder()
String	escapeReservedWord(String name) Return the escaped name of the reserved word
CodegenModel	fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions) Convert Swagger Model object to Codegen Model 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	modelFileFolder()
protected boolean	needToImport(String type) Check the type to see if it needs import the library/module/package
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()
String	toApiImport(String name) Return the fully-qualified "Api" name for import
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	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	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

additionalProperties, addOperationToGroup, apiFilename, apiPackage, apiTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getLibrary, getOrGenerateOperationId, getOutputDir, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initialCaps, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, outputFolder, postProcessModelProperty, postProcessParameter, postProcessSupportingFileData, processSwagger, removeNonNameElementToCamelCase, reservedWords, sanitizeName, setApiPackage, setEnsureUniqueParams, setLibrary, setModelPackage, setNonArrayMapProperty, setOutputDir, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, toApiFilename, toApiName, toApiVarName, toEnumName, toExamples, toInstantiationType, typeMapping, underscore

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, apiFilename, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getLibrary, getOutputDir, getTypeDeclaration, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, outputFolder, postProcessModelProperty, postProcessParameter, postProcessSupportingFileData, processSwagger, reservedWords, setLibrary, setOutputDir, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, toApiFilename, toApiName, toApiVarName, typeMapping

Field Detail

projectName

protected String projectName

moduleName

protected String moduleName

projectDescription

protected String projectDescription

projectVersion

protected String projectVersion

sourceFolder

protected String sourceFolder

localVariablePrefix

protected String localVariablePrefix

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)

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

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

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

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

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

postProcessOperations

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

Specified by:

postProcessOperations in interface CodegenConfig

Overrides:

postProcessOperations 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