cn.featherfly.easyapi.codegen.typescript

类 TypeScriptAxiosCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

cn.featherfly.easyapi.codegen.typescript.TypeScriptAxiosCodegen

所有已实现的接口:

EnableExtParameters, ModuleAbility, WrapResponseAbility, io.swagger.codegen.v3.CodegenConfig

public class TypeScriptAxiosCodegen
extends io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen
implements EnableExtParameters, ModuleAbility, WrapResponseAbility

The type TypescriptAxiosCodegen.

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	apiImportPath
static java.lang.String	DEFAULT_API_PACKAGE
static java.lang.String	DEFAULT_MODEL_PACKAGE
protected java.util.Collection<ExtParameter>	extParameters
protected java.lang.String	module
static java.lang.String	NPM_NAME
static java.lang.String	NPM_REPOSITORY
protected java.lang.String	npmRepository
protected java.lang.String	secondModule

从类继承的字段 io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

languageGenericTypes, modelPropertyNaming, supportsES6

从类继承的字段 io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, copyFistAllOfProperties, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

构造器概要

构造器

构造器和说明
TypeScriptAxiosCodegen()

方法概要

限定符和类型	方法和说明
EnableExtParameters	addExtParameter(ExtParameter extParameter) Add ext parameters enable ext parameters.
java.lang.String	getApiImportPath() Getter for property 'apiImportPath'.
java.lang.String	getDefaultTemplateDir()
java.util.Collection<ExtParameter>	getExtParameters() Getter for property 'extParameters'.
java.lang.String	getHelp()
java.lang.String	getModule() Gets the module.
java.lang.String	getName()
java.lang.String	getNpmRepository()
java.lang.String	getSecondModule() get secondModule value
boolean	isWrapResponse()
java.util.Map<java.lang.String,java.lang.Object>	postProcessAllModels(java.util.Map<java.lang.String,java.lang.Object> objs)
java.util.Map<java.lang.String,java.lang.Object>	postProcessModels(java.util.Map<java.lang.String,java.lang.Object> objs)
java.util.Map<java.lang.String,java.lang.Object>	postProcessOperations(java.util.Map<java.lang.String,java.lang.Object> operations)
java.util.Map<java.lang.String,java.lang.Object>	postProcessOperationsWithModels(java.util.Map<java.lang.String,java.lang.Object> objs, java.util.List<java.lang.Object> allModels)
void	processOpts()
void	setApiImportPath(java.lang.String apiImportPath) Setter for property 'apiImportPath'.
void	setModule(java.lang.String module) Sets the module.
void	setNpmRepository(java.lang.String npmRepository)
void	setSecondModule(java.lang.String secondModule) set secondModule value
void	setWrapResponse(boolean wrapResponse)
java.lang.String	toApiFilename(java.lang.String name)
java.lang.String	toModelFilename(java.lang.String name)
java.lang.String	toModelFilename(java.lang.String name, java.lang.String templateName)
java.lang.String	toRegularExpression(java.lang.String pattern) Overriding toRegularExpression() to avoid escapeText() being called, as it would return a broken regular expression if any escaped character / metacharacter were present.

从类继承的方法 io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

addImport, apiFileFolder, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, getModelPropertyNaming, getNameUsingModelPropertyNaming, getSchemaHandler, getSchemaType, getSupportsES6, getTag, getTypeDeclaration, modelFileFolder, setModelPropertyNaming, setSupportsES6, toDefaultValue, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelName, toOperationId, toParamName, toVarName

从类继承的方法 io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, addHasMore, additionalProperties, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isObjectSchema, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processModelEnums, processOpenAPI, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

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

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

从接口继承的方法 io.swagger.codegen.v3.CodegenConfig

checkAliasModel

字段详细资料

NPM_NAME

public static final java.lang.String NPM_NAME

另请参阅:

常量字段值

NPM_REPOSITORY

public static final java.lang.String NPM_REPOSITORY

另请参阅:

常量字段值

DEFAULT_API_PACKAGE

public static final java.lang.String DEFAULT_API_PACKAGE

另请参阅:

常量字段值

DEFAULT_MODEL_PACKAGE

public static final java.lang.String DEFAULT_MODEL_PACKAGE

另请参阅:

常量字段值

npmRepository

protected java.lang.String npmRepository

extParameters

protected java.util.Collection<ExtParameter> extParameters

module

protected java.lang.String module

secondModule

protected java.lang.String secondModule

apiImportPath

protected java.lang.String apiImportPath

构造器详细资料

TypeScriptAxiosCodegen

public TypeScriptAxiosCodegen()

方法详细资料

getName

public java.lang.String getName()

指定者:

getName 在接口中 io.swagger.codegen.v3.CodegenConfig

getHelp

public java.lang.String getHelp()

指定者:

getHelp 在接口中 io.swagger.codegen.v3.CodegenConfig

getNpmRepository

public java.lang.String getNpmRepository()

setNpmRepository

public void setNpmRepository(java.lang.String npmRepository)

processOpts

public void processOpts()

指定者:

processOpts 在接口中 io.swagger.codegen.v3.CodegenConfig

覆盖:

processOpts 在类中 io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

postProcessOperations

public java.util.Map<java.lang.String,java.lang.Object> postProcessOperations(java.util.Map<java.lang.String,java.lang.Object> operations)

指定者:

postProcessOperations 在接口中 io.swagger.codegen.v3.CodegenConfig

覆盖:

postProcessOperations 在类中 io.swagger.codegen.v3.generators.DefaultCodegenConfig

postProcessOperationsWithModels

public java.util.Map<java.lang.String,java.lang.Object> postProcessOperationsWithModels(java.util.Map<java.lang.String,java.lang.Object> objs,
                                                                                        java.util.List<java.lang.Object> allModels)

指定者:

postProcessOperationsWithModels 在接口中 io.swagger.codegen.v3.CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 io.swagger.codegen.v3.generators.DefaultCodegenConfig

postProcessAllModels

public java.util.Map<java.lang.String,java.lang.Object> postProcessAllModels(java.util.Map<java.lang.String,java.lang.Object> objs)

指定者:

postProcessAllModels 在接口中 io.swagger.codegen.v3.CodegenConfig

覆盖:

postProcessAllModels 在类中 io.swagger.codegen.v3.generators.DefaultCodegenConfig

postProcessModels

public java.util.Map<java.lang.String,java.lang.Object> postProcessModels(java.util.Map<java.lang.String,java.lang.Object> objs)

指定者:

postProcessModels 在接口中 io.swagger.codegen.v3.CodegenConfig

覆盖:

postProcessModels 在类中 io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

toRegularExpression

public java.lang.String toRegularExpression(java.lang.String pattern)

Overriding toRegularExpression() to avoid escapeText() being called, as it would return a broken regular expression if any escaped character / metacharacter were present.

覆盖:

toRegularExpression 在类中 io.swagger.codegen.v3.generators.DefaultCodegenConfig

toModelFilename

public java.lang.String toModelFilename(java.lang.String name)

指定者:

toModelFilename 在接口中 io.swagger.codegen.v3.CodegenConfig

覆盖:

toModelFilename 在类中 io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

toApiFilename

public java.lang.String toApiFilename(java.lang.String name)

指定者:

toApiFilename 在接口中 io.swagger.codegen.v3.CodegenConfig

覆盖:

toApiFilename 在类中 io.swagger.codegen.v3.generators.DefaultCodegenConfig

getDefaultTemplateDir

public java.lang.String getDefaultTemplateDir()

指定者:

getDefaultTemplateDir 在类中 io.swagger.codegen.v3.generators.DefaultCodegenConfig

getExtParameters

public java.util.Collection<ExtParameter> getExtParameters()

从接口复制的说明: EnableExtParameters

Getter for property 'extParameters'.

指定者:

getExtParameters 在接口中 EnableExtParameters

返回:

Value for property 'extParameters'.

addExtParameter

public EnableExtParameters addExtParameter(ExtParameter extParameter)

从接口复制的说明: EnableExtParameters

Add ext parameters enable ext parameters.

指定者:

addExtParameter 在接口中 EnableExtParameters

参数:

extParameter - the ext parameter

返回:

the enable ext parameters

toModelFilename

public java.lang.String toModelFilename(java.lang.String name,
                                        java.lang.String templateName)

指定者:

toModelFilename 在接口中 WrapResponseAbility

getModule

public java.lang.String getModule()

从接口复制的说明: ModuleAbility

Gets the module.

指定者:

getModule 在接口中 ModuleAbility

返回:

the module

setModule

public void setModule(java.lang.String module)

从接口复制的说明: ModuleAbility

Sets the module.

指定者:

setModule 在接口中 ModuleAbility

参数:

module - the new module

isWrapResponse

public boolean isWrapResponse()

指定者:

isWrapResponse 在接口中 WrapResponseAbility

setWrapResponse

public void setWrapResponse(boolean wrapResponse)

指定者:

setWrapResponse 在接口中 WrapResponseAbility

getApiImportPath

public java.lang.String getApiImportPath()

Getter for property 'apiImportPath'.

返回:

Value for property 'apiImportPath'.

setApiImportPath

public void setApiImportPath(java.lang.String apiImportPath)

Setter for property 'apiImportPath'.

参数:

apiImportPath - Value to set for property 'apiImportPath'.

getSecondModule

public java.lang.String getSecondModule()

get secondModule value

指定者:

getSecondModule 在接口中 ModuleAbility

返回:

secondModule

setSecondModule

public void setSecondModule(java.lang.String secondModule)

set secondModule value

指定者:

setSecondModule 在接口中 ModuleAbility

参数:

secondModule - secondModule