org.openapitools.codegen.languages

类 TypeScriptNodeClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

org.openapitools.codegen.languages.TypeScriptNodeClientCodegen

所有已实现的接口:

CodegenConfig

public class TypeScriptNodeClientCodegen
extends AbstractTypeScriptClientCodegen

字段概要

字段

限定符和类型	字段和说明
protected String	apiSuffix
static String	NPM_NAME
static String	NPM_REPOSITORY
static String	NPM_VERSION
protected String	npmName
protected String	npmRepository
protected String	npmVersion
static String	SNAPSHOT

从类继承的字段 org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

languageGenericTypes, modelPropertyNaming, supportsES6

从类继承的字段 org.openapitools.codegen.DefaultCodegen

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

构造器概要

构造器

构造器和说明
TypeScriptNodeClientCodegen()

方法概要

限定符和类型	方法和说明
String	getHelp()
String	getName()
String	getNpmRepository()
String	getNpmVersion()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) returns the OpenAPI type for the property.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
boolean	isDataTypeFile(String dataType)
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperations(Map<String,Object> operations)
void	processOpts()
void	setNpmName(String npmName)
void	setNpmRepository(String npmRepository)
void	setNpmVersion(String npmVersion)
String	toApiFilename(String name) Return the file name of the Api Test
String	toApiImport(String name) Return the fully-qualified "Api" name for import
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelImport(String name) Return the fully-qualified "Model" name for import

从类继承的方法 org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

apiFileFolder, enumValuesToEnumTypeUnion, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, getModelPropertyNaming, getNameUsingModelPropertyNaming, getParameterDataType, getSupportsES6, getTag, isReservedWord, modelFileFolder, numericEnumValuesToEnumTypeUnion, postProcessFile, postProcessModels, setModelPropertyNaming, setSupportsES6, toDefaultValue, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelName, toOperationId, toParamName, toVarName

从类继承的方法 org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, 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, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, 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, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelTestFilename, toRegularExpression, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessModelProperty, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, 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, toApiDocFilename, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, vendorExtensions

字段详细资料

NPM_NAME

public static final String NPM_NAME

另请参阅:

常量字段值

NPM_VERSION

public static final String NPM_VERSION

另请参阅:

常量字段值

NPM_REPOSITORY

public static final String NPM_REPOSITORY

另请参阅:

常量字段值

SNAPSHOT

public static final String SNAPSHOT

另请参阅:

常量字段值

npmName

protected String npmName

npmVersion

protected String npmVersion

npmRepository

protected String npmRepository

apiSuffix

protected String apiSuffix

构造器详细资料

TypeScriptNodeClientCodegen

public TypeScriptNodeClientCodegen()

方法详细资料

getName

public String getName()

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

getHelp

public String getHelp()

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

isDataTypeFile

public boolean isDataTypeFile(String dataType)

覆盖:

isDataTypeFile 在类中 DefaultCodegen

getTypeDeclaration

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

从类复制的说明: DefaultCodegen

Output the type declaration of the property

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 AbstractTypeScriptClientCodegen

参数:

p - property schema

返回:

a string presentation of the property type

toApiName

public String toApiName(String name)

从类复制的说明: DefaultCodegen

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

指定者:

toApiName 在接口中 CodegenConfig

覆盖:

toApiName 在类中 DefaultCodegen

参数:

name - the name of the Api

返回:

capitalized Api name ending with "Api"

toApiFilename

public String toApiFilename(String name)

从类复制的说明: DefaultCodegen

Return the file name of the Api Test

指定者:

toApiFilename 在接口中 CodegenConfig

覆盖:

toApiFilename 在类中 DefaultCodegen

参数:

name - the file name of the Api

返回:

the file name of the Api

toApiImport

public String toApiImport(String name)

从类复制的说明: DefaultCodegen

Return the fully-qualified "Api" name for import

指定者:

toApiImport 在接口中 CodegenConfig

覆盖:

toApiImport 在类中 DefaultCodegen

参数:

name - the name of the "Api"

返回:

the fully-qualified "Api" name for import

toModelFilename

public String toModelFilename(String name)

从类复制的说明: DefaultCodegen

Return the capitalized file name of the model

指定者:

toModelFilename 在接口中 CodegenConfig

覆盖:

toModelFilename 在类中 AbstractTypeScriptClientCodegen

参数:

name - the model name

返回:

the file name of the model

toModelImport

public String toModelImport(String name)

从类复制的说明: DefaultCodegen

Return the fully-qualified "Model" name for import

指定者:

toModelImport 在接口中 CodegenConfig

覆盖:

toModelImport 在类中 DefaultCodegen

参数:

name - the name of the "Model"

返回:

the fully-qualified "Model" name for import

postProcessAllModels

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

指定者:

postProcessAllModels 在接口中 CodegenConfig

覆盖:

postProcessAllModels 在类中 AbstractTypeScriptClientCodegen

postProcessOperations

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

指定者:

postProcessOperations 在接口中 CodegenConfig

覆盖:

postProcessOperations 在类中 DefaultCodegen

参数:

operations - the objects map that will be passed to the templating engine

返回:

the the objects map instance.

setNpmName

public void setNpmName(String npmName)

setNpmVersion

public void setNpmVersion(String npmVersion)

getNpmVersion

public String getNpmVersion()

getNpmRepository

public String getNpmRepository()

setNpmRepository

public void setNpmRepository(String npmRepository)

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 AbstractTypeScriptClientCodegen

getSchemaType

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

从类复制的说明: DefaultCodegen

returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type

覆盖:

getSchemaType 在类中 AbstractTypeScriptClientCodegen

参数:

p - property schema

返回:

string presentation of the type