public class JavascriptClientCodegen extends DefaultCodegen implements CodegenConfig
| 限定符和类型 | 字段和说明 |
|---|---|
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, docExtension, embeddedTemplateDir, enablePostProcessFile, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, globalOpenAPI, globalSchemas, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions| 构造器和说明 |
|---|
JavascriptClientCodegen() |
| 限定符和类型 | 方法和说明 |
|---|---|
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.v3.oas.models.media.Schema model,
Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
Convert OAS Model object to Codegen Model object
|
String |
getHelp() |
String |
getInvokerPackage() |
String |
getModelPropertyNaming() |
String |
getName() |
String |
getSchemaType(io.swagger.v3.oas.models.media.Schema p)
returns the OpenAPI type for the property.
|
CodegenType |
getTag() |
String |
getTypeDeclaration(io.swagger.v3.oas.models.media.Schema 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.
|
void |
postProcessFile(File file,
String fileType)
Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
|
Map<String,Object> |
postProcessModels(Map<String,Object> objs) |
Map<String,Object> |
postProcessOperationsWithModels(Map<String,Object> objs,
List<Object> allModels) |
void |
preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) |
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) |
protected String |
setPropertyExampleValue(CodegenProperty p) |
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.v3.oas.models.media.Schema p)
Return the default value of the property
|
String |
toDefaultValueWithParam(String name,
io.swagger.v3.oas.models.media.Schema 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. status becomes "status"
|
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, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiName, toApiVarName, toArrayModelParamName, toBooleanGetter, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toRegularExpression, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBackclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessOperations, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiName, toApiVarName, toBooleanGetter, toGetter, toSetter, typeMapping, vendorExtensionsprotected 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 在接口中 CodegenConfiggetTag 在类中 DefaultCodegenpublic String getName()
getName 在接口中 CodegenConfiggetName 在类中 DefaultCodegenpublic String getHelp()
getHelp 在接口中 CodegenConfiggetHelp 在类中 DefaultCodegenpublic void processOpts()
processOpts 在接口中 CodegenConfigprocessOpts 在类中 DefaultCodegenpublic void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
preprocessOpenAPI 在接口中 CodegenConfigpreprocessOpenAPI 在类中 DefaultCodegenpublic String escapeReservedWord(String name)
DefaultCodegenescapeReservedWord 在接口中 CodegenConfigescapeReservedWord 在类中 DefaultCodegenname - the name to be escapedthrows Runtime exception as reserved word is not allowed (default behavior)
public String apiTestFileFolder()
apiTestFileFolder 在接口中 CodegenConfigapiTestFileFolder 在类中 DefaultCodegenpublic String modelTestFileFolder()
modelTestFileFolder 在接口中 CodegenConfigmodelTestFileFolder 在类中 DefaultCodegenpublic String apiFileFolder()
apiFileFolder 在接口中 CodegenConfigapiFileFolder 在类中 DefaultCodegenpublic String modelFileFolder()
modelFileFolder 在接口中 CodegenConfigmodelFileFolder 在类中 DefaultCodegenpublic 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 在接口中 CodegenConfigapiDocFileFolder 在类中 DefaultCodegenpublic String modelDocFileFolder()
modelDocFileFolder 在接口中 CodegenConfigmodelDocFileFolder 在类中 DefaultCodegenpublic String toApiDocFilename(String name)
DefaultCodegentoApiDocFilename 在接口中 CodegenConfigtoApiDocFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toModelDocFilename(String name)
DefaultCodegentoModelDocFilename 在接口中 CodegenConfigtoModelDocFilename 在类中 DefaultCodegenname - the model namepublic String toApiTestFilename(String name)
DefaultCodegentoApiTestFilename 在接口中 CodegenConfigtoApiTestFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toModelTestFilename(String name)
DefaultCodegentoModelTestFilename 在接口中 CodegenConfigtoModelTestFilename 在类中 DefaultCodegenname - the model namepublic String getModelPropertyNaming()
public String toVarName(String name)
DefaultCodegentoVarName 在类中 DefaultCodegenname - the variable namepublic String toParamName(String name)
DefaultCodegentoParamName 在接口中 CodegenConfigtoParamName 在类中 DefaultCodegenname - Codegen property objectpublic String toModelName(String name)
DefaultCodegentoModelName 在接口中 CodegenConfigtoModelName 在类中 DefaultCodegenname - the name of the modelpublic String toModelFilename(String name)
DefaultCodegentoModelFilename 在接口中 CodegenConfigtoModelFilename 在类中 DefaultCodegenname - the model namepublic String toModelImport(String name)
DefaultCodegentoModelImport 在接口中 CodegenConfigtoModelImport 在类中 DefaultCodegenname - the name of the "Model"public String toApiImport(String name)
DefaultCodegentoApiImport 在接口中 CodegenConfigtoApiImport 在类中 DefaultCodegenname - the name of the "Api"public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetTypeDeclaration 在接口中 CodegenConfiggetTypeDeclaration 在类中 DefaultCodegenp - property schemapublic String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegentoDefaultValue 在类中 DefaultCodegenp - Property schemapublic void setModelPropertyNaming(String naming)
public String toDefaultValueWithParam(String name, io.swagger.v3.oas.models.media.Schema p)
DefaultCodegentoDefaultValueWithParam 在类中 DefaultCodegenname - Name of the property objectp - Property schemapublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegensetParameterExampleValue 在类中 DefaultCodegenp - Codegen parameterprotected String setPropertyExampleValue(CodegenProperty p)
public String normalizeType(String type)
type - Primitive typepublic String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetSchemaType 在类中 DefaultCodegenp - property schemapublic String toOperationId(String operationId)
DefaultCodegentoOperationId 在类中 DefaultCodegenoperationId - operation IDpublic CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema model, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
DefaultCodegenfromModel 在接口中 CodegenConfigfromModel 在类中 DefaultCodegenname - the name of the modelmodel - OAS Model objectallDefinitions - a map of all OAS models from the specpublic Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
public Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels 在接口中 CodegenConfigpostProcessModels 在类中 DefaultCodegenprotected boolean needToImport(String type)
DefaultCodegenneedToImport 在类中 DefaultCodegentype - name of the typepublic String toEnumName(CodegenProperty property)
DefaultCodegentoEnumName 在类中 DefaultCodegenproperty - Codegen propertypublic String toEnumVarName(String value, String datatype)
DefaultCodegentoEnumVarName 在类中 DefaultCodegenvalue - enum variable namedatatype - data typepublic String toEnumValue(String value, String datatype)
DefaultCodegentoEnumValue 在类中 DefaultCodegenvalue - enum variable namedatatype - data typepublic String escapeQuotationMark(String input)
DefaultCodegenescapeQuotationMark 在接口中 CodegenConfigescapeQuotationMark 在类中 DefaultCodegeninput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenescapeUnsafeCharacters 在接口中 CodegenConfigescapeUnsafeCharacters 在类中 DefaultCodegeninput - String to be cleaned uppublic void postProcessFile(File file, String fileType)
DefaultCodegenTODO: store these values in enum instead
postProcessFile 在接口中 CodegenConfigpostProcessFile 在类中 DefaultCodegenfile - file to be processedfileType - file typeCopyright © 2019. All rights reserved.