public class JavascriptClientCodegen extends DefaultCodegen implements CodegenConfig
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 |
licenseName |
protected String |
localVariablePrefix |
protected String |
modelDocPath |
protected String |
modelTestPath |
static String |
MODULE_NAME |
protected String |
moduleName |
static String |
PROJECT_DESCRIPTION |
static String |
PROJECT_NAME |
static String |
PROJECT_VERSION |
protected String |
projectDescription |
protected String |
projectName |
protected String |
projectVersion |
protected String |
sourceFolder |
static String |
USE_ES6 |
static String |
USE_INHERITANCE |
static String |
USE_PROMISES |
protected boolean |
useES6 |
protected boolean |
usePromises |
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions
Constructor and Description |
---|
JavascriptClientCodegen() |
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 |
getInvokerPackage() |
String |
getModelPropertyNaming() |
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 |
setLicenseName(String licenseName) |
void |
setLocalVariablePrefix(String localVariablePrefix) |
void |
setModelPropertyNaming(String naming) |
void |
setModuleName(String moduleName) |
void |
setParameterExampleValue(CodegenParameter p)
Return the example value of the parameter.
|
void |
setProjectDescription(String projectDescription) |
void |
setProjectName(String projectName) |
void |
setProjectVersion(String projectVersion) |
void |
setSourceFolder(String sourceFolder) |
void |
setUseES6(boolean useES6) |
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 specified 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.
|
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getAlias, getCommonTemplateDir, getExamples, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterDataType, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isHideGenerationTimestamp, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processSwagger, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiName, toApiVarName, toBooleanGetter, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processSwagger, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiName, toApiVarName, toBooleanGetter, toGetter, toSetter, typeMapping, vendorExtensions
public static final String PROJECT_NAME
public static final String MODULE_NAME
public static final String PROJECT_DESCRIPTION
public static final String PROJECT_VERSION
public static final String USE_PROMISES
public static final String USE_INHERITANCE
public static final String EMIT_MODEL_METHODS
public static final String EMIT_JS_DOC
public static final String USE_ES6
protected String projectName
protected String moduleName
protected String projectDescription
protected String projectVersion
protected String licenseName
protected String invokerPackage
protected String sourceFolder
protected String localVariablePrefix
protected boolean usePromises
protected boolean emitModelMethods
protected boolean emitJSDoc
protected String apiDocPath
protected String modelDocPath
protected String apiTestPath
protected String modelTestPath
protected boolean useES6
public CodegenType getTag()
getTag
in interface CodegenConfig
public String getName()
getName
in interface CodegenConfig
public String getHelp()
getHelp
in interface CodegenConfig
public void processOpts()
processOpts
in interface CodegenConfig
processOpts
in class DefaultCodegen
public void preprocessSwagger(io.swagger.models.Swagger swagger)
preprocessSwagger
in interface CodegenConfig
preprocessSwagger
in class DefaultCodegen
public String escapeReservedWord(String name)
DefaultCodegen
escapeReservedWord
in interface CodegenConfig
escapeReservedWord
in class DefaultCodegen
name
- the name to be escapedpublic String apiTestFileFolder()
apiTestFileFolder
in interface CodegenConfig
apiTestFileFolder
in class DefaultCodegen
public String modelTestFileFolder()
modelTestFileFolder
in interface CodegenConfig
modelTestFileFolder
in class DefaultCodegen
public String apiFileFolder()
apiFileFolder
in interface CodegenConfig
apiFileFolder
in class DefaultCodegen
public String modelFileFolder()
modelFileFolder
in interface CodegenConfig
modelFileFolder
in class DefaultCodegen
public String getInvokerPackage()
public void setInvokerPackage(String invokerPackage)
public void setSourceFolder(String sourceFolder)
public void setProjectName(String projectName)
public void setLocalVariablePrefix(String localVariablePrefix)
public void setModuleName(String moduleName)
public void setProjectDescription(String projectDescription)
public void setProjectVersion(String projectVersion)
public void setLicenseName(String licenseName)
public void setUsePromises(boolean usePromises)
public void setUseES6(boolean useES6)
public void setUseInheritance(boolean useInheritance)
public void setEmitModelMethods(boolean emitModelMethods)
public void setEmitJSDoc(boolean emitJSDoc)
public String apiDocFileFolder()
apiDocFileFolder
in interface CodegenConfig
apiDocFileFolder
in class DefaultCodegen
public String modelDocFileFolder()
modelDocFileFolder
in interface CodegenConfig
modelDocFileFolder
in class DefaultCodegen
public String toApiDocFilename(String name)
DefaultCodegen
toApiDocFilename
in interface CodegenConfig
toApiDocFilename
in class DefaultCodegen
name
- the file name of the Apipublic String toModelDocFilename(String name)
DefaultCodegen
toModelDocFilename
in interface CodegenConfig
toModelDocFilename
in class DefaultCodegen
name
- the model namepublic String toApiTestFilename(String name)
DefaultCodegen
toApiTestFilename
in interface CodegenConfig
toApiTestFilename
in class DefaultCodegen
name
- the file name of the Apipublic String toModelTestFilename(String name)
DefaultCodegen
toModelTestFilename
in interface CodegenConfig
toModelTestFilename
in class DefaultCodegen
name
- the model namepublic String getModelPropertyNaming()
public String toVarName(String name)
DefaultCodegen
toVarName
in class DefaultCodegen
name
- the variable namepublic String toParamName(String name)
DefaultCodegen
toParamName
in interface CodegenConfig
toParamName
in class DefaultCodegen
name
- Codegen property objectpublic String toModelName(String name)
DefaultCodegen
toModelName
in interface CodegenConfig
toModelName
in class DefaultCodegen
name
- the name of the modelpublic String toModelFilename(String name)
DefaultCodegen
toModelFilename
in interface CodegenConfig
toModelFilename
in class DefaultCodegen
name
- the model namepublic String toModelImport(String name)
DefaultCodegen
toModelImport
in interface CodegenConfig
toModelImport
in class DefaultCodegen
name
- the name of the "Model"public String toApiImport(String name)
DefaultCodegen
toApiImport
in interface CodegenConfig
toApiImport
in class DefaultCodegen
name
- the name of the "Api"public String getTypeDeclaration(io.swagger.models.properties.Property p)
DefaultCodegen
getTypeDeclaration
in interface CodegenConfig
getTypeDeclaration
in class DefaultCodegen
p
- Swagger Property objectpublic String toDefaultValue(io.swagger.models.properties.Property p)
DefaultCodegen
toDefaultValue
in class DefaultCodegen
p
- Swagger property objectpublic void setModelPropertyNaming(String naming)
public String toDefaultValueWithParam(String name, io.swagger.models.properties.Property p)
DefaultCodegen
toDefaultValueWithParam
in class DefaultCodegen
name
- Name of the property objectp
- Swagger property objectpublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegen
setParameterExampleValue
in class DefaultCodegen
p
- Swagger property objectpublic String normalizeType(String type)
type
- Primitive typepublic String getSwaggerType(io.swagger.models.properties.Property p)
DefaultCodegen
getSwaggerType
in class DefaultCodegen
p
- Swagger property objectpublic String toOperationId(String operationId)
DefaultCodegen
toOperationId
in class DefaultCodegen
operationId
- operation IDpublic CodegenOperation fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions, io.swagger.models.Swagger swagger)
DefaultCodegen
fromOperation
in interface CodegenConfig
fromOperation
in class DefaultCodegen
path
- the path of the operationhttpMethod
- HTTP methodoperation
- Swagger operation objectdefinitions
- a map of Swagger modelsswagger
- a Swagger object representing the specpublic CodegenModel fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions)
DefaultCodegen
fromModel
in interface CodegenConfig
fromModel
in class DefaultCodegen
name
- the name of the modelmodel
- Swagger Model objectallDefinitions
- a map of all Swagger models from the specpublic Map<String,Object> postProcessOperations(Map<String,Object> objs)
postProcessOperations
in interface CodegenConfig
postProcessOperations
in class DefaultCodegen
public Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels
in interface CodegenConfig
postProcessModels
in class DefaultCodegen
protected boolean needToImport(String type)
DefaultCodegen
needToImport
in class DefaultCodegen
type
- name of the typepublic String toEnumName(CodegenProperty property)
DefaultCodegen
toEnumName
in class DefaultCodegen
property
- Codegen propertypublic String toEnumVarName(String value, String datatype)
DefaultCodegen
toEnumVarName
in class DefaultCodegen
value
- enum variable namedatatype
- data typepublic String toEnumValue(String value, String datatype)
DefaultCodegen
toEnumValue
in class DefaultCodegen
value
- enum variable namedatatype
- data typepublic String escapeQuotationMark(String input)
DefaultCodegen
escapeQuotationMark
in interface CodegenConfig
escapeQuotationMark
in class DefaultCodegen
input
- String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegen
escapeUnsafeCharacters
in interface CodegenConfig
escapeUnsafeCharacters
in class DefaultCodegen
input
- String to be cleaned upCopyright © 2019. All rights reserved.