Package io.swagger.codegen.v3.generators.typescript

Class TypeScriptAngularClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

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

io.swagger.codegen.v3.generators.typescript.TypeScriptAngularClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class TypeScriptAngularClientCodegen
extends AbstractTypeScriptClientCodegen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEBAB_FILE_NAME
protected boolean	kebabFileNaming
static final String	NG_PACKAGR
static final String	NG_VERSION
static final String	NPM_NAME
static final String	NPM_REPOSITORY
static final String	NPM_VERSION
protected String	npmName
protected String	npmRepository
protected String	npmVersion
static final String	PROVIDED_IN_ROOT
static final String	SNAPSHOT
static final String	USE_OVERRIDE
static final String	WITH_INTERFACES

Fields inherited from class io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

languageGenericTypes, modelPropertyNaming, supportsES6

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, 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

Constructor Summary

Constructors

Constructor	Description
TypeScriptAngularClientCodegen()

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)
protected void	addOperationImports(io.swagger.codegen.v3.CodegenOperation codegenOperation, Set<String> operationImports)
String	getArgumentsLocation()
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
String	getNpmName()
String	getNpmRepository()
String	getNpmVersion()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema schema)	returns the swagger type for the property
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)	Output the type declaration of the property
boolean	isDataTypeFile(String dataType)
Map<String,Object>	postProcessAllModels(Map<String,Object> processedModels)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperations(Map<String,Object> operations)
void	postProcessParameter(io.swagger.codegen.v3.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

Methods inherited from class io.swagger.codegen.v3.generators.typescript.AbstractTypeScriptClientCodegen

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

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, additionalProperties, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, 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, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelTestFilename, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

checkAliasModel, getCodeName, getPriority, isPrivileged

Field Details

NPM_NAME

public static final String NPM_NAME

See Also:

• Constant Field Values

NPM_VERSION

public static final String NPM_VERSION

See Also:

• Constant Field Values

NPM_REPOSITORY

public static final String NPM_REPOSITORY

See Also:

• Constant Field Values

SNAPSHOT

public static final String SNAPSHOT

See Also:

• Constant Field Values

WITH_INTERFACES

public static final String WITH_INTERFACES

See Also:

• Constant Field Values

NG_VERSION

public static final String NG_VERSION

See Also:

• Constant Field Values

NG_PACKAGR

public static final String NG_PACKAGR

See Also:

• Constant Field Values

PROVIDED_IN_ROOT

public static final String PROVIDED_IN_ROOT

See Also:

• Constant Field Values

KEBAB_FILE_NAME

public static final String KEBAB_FILE_NAME

See Also:

• Constant Field Values

USE_OVERRIDE

public static final String USE_OVERRIDE

See Also:

• Constant Field Values

npmName

protected String npmName

npmVersion

protected String npmVersion

npmRepository

protected String npmRepository

kebabFileNaming

protected boolean kebabFileNaming

Constructor Details

TypeScriptAngularClientCodegen

public TypeScriptAngularClientCodegen()

Method Details

addAdditionPropertiesToCodeGenModel

protected void addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel,
 io.swagger.v3.oas.models.media.Schema schema)

Overrides:

addAdditionPropertiesToCodeGenModel in class DefaultCodegenConfig

getName

public String getName()

getHelp

public String getHelp()

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class AbstractTypeScriptClientCodegen

isDataTypeFile

public boolean isDataTypeFile(String dataType)

Overrides:

isDataTypeFile in class DefaultCodegenConfig

getArgumentsLocation

public String getArgumentsLocation()

Overrides:

getArgumentsLocation in class DefaultCodegenConfig

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

getTypeDeclaration

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

Description copied from class: DefaultCodegenConfig

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

getTypeDeclaration in class AbstractTypeScriptClientCodegen

Parameters:

propertySchema - Schema Property object

Returns:

a string presentation of the property type

getSchemaType

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

Description copied from class: DefaultCodegenConfig

returns the swagger type for the property

Overrides:

getSchemaType in class AbstractTypeScriptClientCodegen

Parameters:

schema - Schema property object

Returns:

string presentation of the type

addOperationImports

protected void addOperationImports(io.swagger.codegen.v3.CodegenOperation codegenOperation,
 Set<String> operationImports)

Overrides:

addOperationImports in class DefaultCodegenConfig

postProcessParameter

public void postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)

Specified by:

postProcessParameter in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegenConfig

postProcessOperations

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

Specified by:

postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessOperations in class DefaultCodegenConfig

postProcessModels

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

Specified by:

postProcessModels in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModels in class AbstractTypeScriptClientCodegen

postProcessAllModels

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

Specified by:

postProcessAllModels in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegenConfig

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegenConfig

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

Specified by:

toApiName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiName in class DefaultCodegenConfig

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Test

Specified by:

toApiFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiImport

public String toApiImport(String name)

Description copied from class: DefaultCodegenConfig

Return the fully-qualified "Api" name for import

Specified by:

toApiImport in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiImport in class DefaultCodegenConfig

Parameters:

name - the name of the "Api"

Returns:

the fully-qualified "Api" name for import

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model

Specified by:

toModelFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelFilename in class AbstractTypeScriptClientCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toModelImport

public String toModelImport(String name)

Description copied from class: DefaultCodegenConfig

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelImport in class DefaultCodegenConfig

Parameters:

name - the name of the "Model"

Returns:

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)