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

Class TypeScriptAxiosClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

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

io.swagger.codegen.v3.generators.typescript.TypeScriptAxiosClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class TypeScriptAxiosClientCodegen
extends AbstractTypeScriptClientCodegen

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_API_PACKAGE
static String	DEFAULT_MODEL_PACKAGE
static String	NPM_NAME
static String	NPM_REPOSITORY
static String	NPM_VERSION
protected String	npmName
protected String	npmRepository
protected String	npmVersion

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

languageGenericTypes, LOGGER, 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
TypeScriptAxiosClientCodegen()

Method Summary

Modifier and Type	Method	Description
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
String	getNpmName()	Gets the name of the generated NPM package.
String	getNpmRepository()	Gets the name of the NPM registry the package is published to.
String	getNpmVersion()	Gets the generated NPM package SemVer string.
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperations(Map<String,Object> operations)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
protected void	processMapSchema(io.swagger.codegen.v3.CodegenModel codegenModel, String name, io.swagger.v3.oas.models.media.Schema schema)
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	toModelFilename(String name)	Return the capitalized file name of the model
String	toRegularExpression(String pattern)	Overriding toRegularExpression() to avoid escapeText() being called, as it would return a broken regular expression if any escaped character / metacharacter were present.

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

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

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

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, additionalProperties, addOperationImports, 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, getArgumentsLocation, 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, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, 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, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, 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 Detail

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

DEFAULT_API_PACKAGE

public static final String DEFAULT_API_PACKAGE

See Also:

Constant Field Values

DEFAULT_MODEL_PACKAGE

public static final String DEFAULT_MODEL_PACKAGE

See Also:

Constant Field Values

npmRepository

protected String npmRepository

npmName

protected String npmName

npmVersion

protected String npmVersion

Constructor Detail

TypeScriptAxiosClientCodegen

public TypeScriptAxiosClientCodegen()

Method Detail

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

processMapSchema

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

Overrides:

processMapSchema 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

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                                List<Object> allModels)

Specified by:

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

Overrides:

postProcessOperationsWithModels in class DefaultCodegenConfig

postProcessAllModels

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

Specified by:

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

Overrides:

postProcessAllModels 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

toRegularExpression

public String toRegularExpression(String pattern)

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

Overrides:

toRegularExpression in class DefaultCodegenConfig

Parameters:

pattern - the pattern (regular expression)

Returns:

properly-escaped pattern

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

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

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

getNpmName

public String getNpmName()

Gets the name of the generated NPM package.

Returns:

The NPM package name.

setNpmName

public void setNpmName(String npmName)

getNpmVersion

public String getNpmVersion()

Gets the generated NPM package SemVer string.

Returns:

The package version.

setNpmVersion

public void setNpmVersion(String npmVersion)

getNpmRepository

public String getNpmRepository()

Gets the name of the NPM registry the package is published to.

Returns:

The NPM registry name.

setNpmRepository

public void setNpmRepository(String npmRepository)