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

Class TypeScriptFetchClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

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

io.swagger.codegen.v3.generators.typescript.TypeScriptFetchClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class TypeScriptFetchClientCodegen
extends AbstractTypeScriptClientCodegen

Field Summary

Fields

Modifier and Type	Field	Description
static String	NPM_NAME
static String	NPM_REPOSITORY
static String	NPM_VERSION
protected String	npmName
protected String	npmRepository
protected String	npmVersion
static String	SNAPSHOT
static String	WITH_INTERFACES

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
TypeScriptFetchClientCodegen()

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)
io.swagger.codegen.v3.CodegenParameter	fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter, Set<String> imports)	Convert Swagger Parameter object to Codegen Parameter object
io.swagger.codegen.v3.CodegenParameter	fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> schemas, Set<String> imports)
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
void	postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)
void	processOpts()
void	setNpmName(String npmName)
void	setNpmRepository(String npmRepository)
void	setNpmVersion(String npmVersion)

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

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

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

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, fromProperty, 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, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelImport, 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 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

SNAPSHOT

public static final String SNAPSHOT

See Also:

Constant Field Values

WITH_INTERFACES

public static final String WITH_INTERFACES

See Also:

Constant Field Values

npmName

protected String npmName

npmVersion

protected String npmVersion

npmRepository

protected String npmRepository

Constructor Detail

TypeScriptFetchClientCodegen

public TypeScriptFetchClientCodegen()

Method Detail

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

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

fromParameter

public io.swagger.codegen.v3.CodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter,
                                                            Set<String> imports)

Description copied from class: DefaultCodegenConfig

Convert Swagger Parameter object to Codegen Parameter object

Overrides:

fromParameter in class DefaultCodegenConfig

Parameters:

parameter - Swagger parameter object

imports - set of imports for library/package/module

Returns:

Codegen Parameter object

fromRequestBody

public io.swagger.codegen.v3.CodegenParameter fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body,
                                                              String name,
                                                              io.swagger.v3.oas.models.media.Schema schema,
                                                              Map<String,io.swagger.v3.oas.models.media.Schema> schemas,
                                                              Set<String> imports)

Overrides:

fromRequestBody in class DefaultCodegenConfig

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

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

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)