TypeScriptAngularClientCodegen (openapi-generator (core library) 3.3.4.2 API)

java.lang.Object
- org.openapitools.codegen.DefaultCodegen
- - org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen
  - - org.openapitools.codegen.languages.TypeScriptAngularClientCodegen

所有已实现的接口:: CodegenConfig

public class TypeScriptAngularClientCodegen
extends AbstractTypeScriptClientCodegen

字段概要

字段
限定符和类型	字段和说明
`static String`	`FILE_NAMING`
`protected String`	`fileNaming`
`static String`	`MODEL_FILE_SUFFIX`
`static String`	`MODEL_SUFFIX`
`protected String`	`modelFileSuffix`
`protected String`	`modelSuffix`
`static String`	`NG_VERSION`
`static String`	`NPM_NAME`
`static String`	`NPM_REPOSITORY`
`static String`	`NPM_VERSION`
`protected String`	`npmName`
`protected String`	`npmRepository`
`protected String`	`npmVersion`
`static String`	`PROVIDED_IN_ROOT`
`static String`	`SERVICE_FILE_SUFFIX`
`static String`	`SERVICE_SUFFIX`
`protected String`	`serviceFileSuffix`
`protected String`	`serviceSuffix`
`static String`	`SNAPSHOT`
`static String`	`TAGGED_UNIONS`
`static String`	`WITH_INTERFACES`

从类继承的字段 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

构造器概要

构造器
构造器和说明

TypeScriptAngularClientCodegen()

构造器
构造器和说明
`TypeScriptAngularClientCodegen()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)`
`String`	`getHelp()`
`String`	`getName()`
`String`	`getNpmName()`
`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>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperationsWithModels(Map<String,Object> operations, List<Object> allModels)`
`void`	`postProcessParameter(CodegenParameter parameter)`
`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
`String`	`toModelName(String name)` Output the proper model name (capitalized).

从类继承的方法 org.openapitools.codegen.DefaultCodegen
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, postProcessOperations, 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, postProcessOperations, 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
```
    另请参阅:
    
    常量字段值
  - WITH_INTERFACES
```
public static final String WITH_INTERFACES
```
    另请参阅:
    
    常量字段值
  - TAGGED_UNIONS
```
public static final String TAGGED_UNIONS
```
    另请参阅:
    
    常量字段值
  - NG_VERSION
```
public static final String NG_VERSION
```
    另请参阅:
    
    常量字段值
  - PROVIDED_IN_ROOT
```
public static final String PROVIDED_IN_ROOT
```
    另请参阅:
    
    常量字段值
  - SERVICE_SUFFIX
```
public static final String SERVICE_SUFFIX
```
    另请参阅:
    
    常量字段值
  - SERVICE_FILE_SUFFIX
```
public static final String SERVICE_FILE_SUFFIX
```
    另请参阅:
    
    常量字段值
  - MODEL_SUFFIX
```
public static final String MODEL_SUFFIX
```
    另请参阅:
    
    常量字段值
  - MODEL_FILE_SUFFIX
```
public static final String MODEL_FILE_SUFFIX
```
    另请参阅:
    
    常量字段值
  - FILE_NAMING
```
public static final String FILE_NAMING
```
    另请参阅:
    
    常量字段值
  - npmName
```
protected String npmName
```
  - npmVersion
```
protected String npmVersion
```
  - npmRepository
```
protected String npmRepository
```
  - serviceSuffix
```
protected String serviceSuffix
```
  - serviceFileSuffix
```
protected String serviceFileSuffix
```
  - modelSuffix
```
protected String modelSuffix
```
  - modelFileSuffix
```
protected String modelFileSuffix
```
  - fileNaming
```
protected String fileNaming
```
- 构造器详细资料
  - TypeScriptAngularClientCodegen
```
public TypeScriptAngularClientCodegen()
```
- 方法详细资料
  - addAdditionPropertiesToCodeGenModel
```
protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
                                                   io.swagger.v3.oas.models.media.Schema schema)
```
    覆盖:
    
    addAdditionPropertiesToCodeGenModel 在类中 DefaultCodegen
  - getName
```
public String getName()
```
    指定者:
    
    getName 在接口中 CodegenConfig
    
    覆盖:
    
    getName 在类中 DefaultCodegen
  - getHelp
```
public String getHelp()
```
    指定者:
    
    getHelp 在接口中 CodegenConfig
    
    覆盖:
    
    getHelp 在类中 DefaultCodegen
  - processOpts
```
public void processOpts()
```
    指定者:
    
    processOpts 在接口中 CodegenConfig
    
    覆盖:
    
    processOpts 在类中 AbstractTypeScriptClientCodegen
  - 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
  - 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
  - postProcessParameter
```
public void postProcessParameter(CodegenParameter parameter)
```
    指定者:
    
    postProcessParameter 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessParameter 在类中 DefaultCodegen
  - postProcessOperationsWithModels
```
public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> operations,
                                                          List<Object> allModels)
```
    指定者:
    
    postProcessOperationsWithModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessOperationsWithModels 在类中 DefaultCodegen
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    指定者:
    
    postProcessModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessModels 在类中 AbstractTypeScriptClientCodegen
  - postProcessAllModels
```
public Map<String,Object> postProcessAllModels(Map<String,Object> objs)
```
    指定者:
    
    postProcessAllModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessAllModels 在类中 AbstractTypeScriptClientCodegen
  - 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
  - getNpmName
```
public String getNpmName()
```
  - setNpmName
```
public void setNpmName(String npmName)
```
  - getNpmVersion
```
public String getNpmVersion()
```
  - setNpmVersion
```
public void setNpmVersion(String npmVersion)
```
  - getNpmRepository
```
public String getNpmRepository()
```
  - setNpmRepository
```
public void setNpmRepository(String npmRepository)
```
  - toModelName
```
public String toModelName(String name)
```
    从类复制的说明: DefaultCodegen
    
    Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.
    
    指定者:
    
    toModelName 在接口中 CodegenConfig
    
    覆盖:
    
    toModelName 在类中 AbstractTypeScriptClientCodegen
    
    参数:
    
    name - the name of the model
    
    返回:
    
    capitalized model name

类 TypeScriptAngularClientCodegen

字段概要

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

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

构造器概要

方法概要

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

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

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

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

字段详细资料

NPM_NAME

NPM_VERSION

NPM_REPOSITORY

SNAPSHOT

WITH_INTERFACES

TAGGED_UNIONS

NG_VERSION

PROVIDED_IN_ROOT

SERVICE_SUFFIX

SERVICE_FILE_SUFFIX

MODEL_SUFFIX

MODEL_FILE_SUFFIX

FILE_NAMING

npmName

npmVersion

npmRepository

serviceSuffix

serviceFileSuffix

modelSuffix

modelFileSuffix

fileNaming

构造器详细资料

TypeScriptAngularClientCodegen

方法详细资料

addAdditionPropertiesToCodeGenModel

getName

getHelp

processOpts

isDataTypeFile

getTypeDeclaration

getSchemaType

postProcessParameter

postProcessOperationsWithModels

postProcessModels

postProcessAllModels

toApiName

toApiFilename

toApiImport

toModelFilename

toModelImport

getNpmName

setNpmName

getNpmVersion

setNpmVersion

getNpmRepository

setNpmRepository

toModelName