org.openapitools.codegen.languages

Class TypeScriptFetchClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

All Implemented Interfaces:

CodegenConfig

public class TypeScriptFetchClientCodegen
extends AbstractTypeScriptClientCodegen

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addedApiIndex
protected boolean	addedModelIndex
static String	NPM_REPOSITORY
protected String	npmRepository
static String	PREFIX_PARAMETER_INTERFACES
static String	TYPESCRIPT_THREE_PLUS
protected boolean	typescriptThreePlus
static String	USE_SINGLE_REQUEST_PARAMETER
static String	WITH_INTERFACES

Fields inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

classEnumSeparator, enumPropertyNaming, enumSuffix, languageGenericTypes, modelPropertyNaming, NPM_NAME, NPM_VERSION, npmName, npmVersion, SNAPSHOT, SNAPSHOT_SUFFIX_FORMAT, supportsES6

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, DefaultFeatureSet, defaultIncludes, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, featureSet, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
TypeScriptFetchClientCodegen()

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)
String	getHelp()
String	getName()
String	getNpmRepository()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
Boolean	getTypescriptThreePlus()
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	processOpts()
void	setNpmRepository(String npmRepository)
void	setTypescriptThreePlus(Boolean typescriptThreePlus)

Methods inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

addImport, apiFileFolder, escapeQuotationMark, escapeReservedWord, escapeText, escapeUnsafeCharacters, getEnumPropertyNaming, getModelPropertyNaming, getNpmName, getNpmVersion, getParameterDataType, getSchemaType, getSupportsES6, getTag, isReservedWord, modelFileFolder, postProcessFile, preprocessOpenAPI, setEnumPropertyNaming, setModelPropertyNaming, setNpmName, setNpmVersion, setSupportsES6, toAllOfName, toAnyOfName, toDefaultValue, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelFilename, toModelName, toOneOfName, toOperationId, toParamName, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addHeaders, additionalProperties, addMustacheLambdas, addOperationToGroup, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, defaultIncludes, embeddedTemplateDir, encodePath, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getAllModels, getAllowUnicodeIdentifiers, getApiNameSuffix, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getEnsureUniqueParams, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaItems, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiNameSuffix, setApiPackage, setCircularReferences, setCommonTemplateDir, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setFeatureSet, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, toRegularExpression, toSetter, typeMapping, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateOption, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessModelProperty, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setFeatureSet, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

NPM_REPOSITORY

public static final String NPM_REPOSITORY

See Also:

Constant Field Values

WITH_INTERFACES

public static final String WITH_INTERFACES

See Also:

Constant Field Values

USE_SINGLE_REQUEST_PARAMETER

public static final String USE_SINGLE_REQUEST_PARAMETER

See Also:

Constant Field Values

PREFIX_PARAMETER_INTERFACES

public static final String PREFIX_PARAMETER_INTERFACES

See Also:

Constant Field Values

TYPESCRIPT_THREE_PLUS

public static final String TYPESCRIPT_THREE_PLUS

See Also:

Constant Field Values

npmRepository

protected String npmRepository

addedApiIndex

protected boolean addedApiIndex

addedModelIndex

protected boolean addedModelIndex

typescriptThreePlus

protected boolean typescriptThreePlus

Constructor Detail

TypeScriptFetchClientCodegen

public TypeScriptFetchClientCodegen()

Method Detail

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

getNpmRepository

public String getNpmRepository()

setNpmRepository

public void setNpmRepository(String npmRepository)

getTypescriptThreePlus

public Boolean getTypescriptThreePlus()

setTypescriptThreePlus

public void setTypescriptThreePlus(Boolean typescriptThreePlus)

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractTypeScriptClientCodegen

getTypeDeclaration

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

Description copied from class: DefaultCodegen

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractTypeScriptClientCodegen

Parameters:

p - property schema

Returns:

a string presentation of the property type

addAdditionPropertiesToCodeGenModel

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

Overrides:

addAdditionPropertiesToCodeGenModel in class DefaultCodegen

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractTypeScriptClientCodegen

postProcessAllModels

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

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class AbstractTypeScriptClientCodegen

postProcessOperationsWithModels

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

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen