public class TypeScriptFetchClientCodegen extends AbstractTypeScriptClientCodegen
| Modifier and Type | Field and Description |
|---|---|
protected boolean |
addedApiIndex |
protected boolean |
addedModelIndex |
static String |
DETECT_PASSTHROUGH_MODELS_WITH_SUFFIX_AND_FIELD |
protected String |
detectPassthroughModelsWithSuffixAndField |
static String |
INFER_ENTITY_FROM_UNIQUE_ID_WITH_NAME |
static String |
INFER_UNIQUE_ID_FROM_NAME_SUFFIX |
protected String |
inferEntityFromUniqueIdWithName |
protected boolean |
inferUniqueIdFromNameSuffix |
static String |
NPM_REPOSITORY |
protected String |
npmRepository |
static String |
PACKAGE_AS_SOURCE_ONLY_LIBRARY |
protected boolean |
packageAsSourceOnlyLibrary |
static String |
PREFIX_PARAMETER_INTERFACES |
static String |
SAGAS_AND_RECORDS |
protected boolean |
sagasAndRecords |
static String |
TYPESCRIPT_THREE_PLUS |
protected boolean |
typescriptThreePlus |
static String |
USE_SINGLE_REQUEST_PARAMETER |
static String |
WITH_INTERFACES |
static String |
WITHOUT_RUNTIME_CHECKS |
protected boolean |
withoutRuntimeChecks |
classEnumSeparator, enumPropertyNaming, enumSuffix, languageGenericTypes, MODEL_PROPERTY_NAMING_DESC_WITH_WARNING, modelPropertyNaming, NPM_NAME, NPM_VERSION, npmName, npmVersion, NULL_SAFE_ADDITIONAL_PROPS, NULL_SAFE_ADDITIONAL_PROPS_DESC, nullSafeAdditionalProps, paramNaming, SNAPSHOT, SNAPSHOT_SUFFIX_FORMAT, supportsES6additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumUnknownDefaultCase, enumUnknownDefaultCaseName, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename| Constructor and Description |
|---|
TypeScriptFetchClientCodegen() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
io.swagger.v3.oas.models.media.Schema schema)
Handle the model for the 'additionalProperties' keyword in the OAS schema.
|
protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> |
addMustacheLambdas()
Preset map builder with commonly used Mustache lambdas.
|
String |
escapeReservedWord(String name)
Return the escaped name of the reserved word
|
CodegenParameter |
fromFormProperty(String name,
io.swagger.v3.oas.models.media.Schema propertySchema,
Set<String> imports) |
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenModel |
fromModel(String name,
io.swagger.v3.oas.models.media.Schema model)
Convert OAS Model object to Codegen Model object.
|
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenOperation |
fromOperation(String path,
String httpMethod,
io.swagger.v3.oas.models.Operation operation,
List<io.swagger.v3.oas.models.servers.Server> servers)
Convert OAS Operation object to Codegen Operation object
|
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenParameter |
fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter,
Set<String> imports)
Convert OAS Parameter object to Codegen Parameter object
|
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenProperty |
fromProperty(String name,
io.swagger.v3.oas.models.media.Schema p)
Convert OAS Property object to Codegen Property object.
|
CodegenParameter |
fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body,
Set<String> imports,
String bodyParameterName) |
List<CodegenParameter> |
fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body,
Set<String> imports) |
String |
getDetectPassthroughModelsWithSuffixAndField() |
protected String |
getEnumDefaultValue(String defaultValue,
String dataType) |
String |
getHelp() |
String |
getInferEntityFromUniqueIdWithName() |
boolean |
getInferUniqueIdFromNameSuffix() |
String |
getName() |
String |
getNpmRepository() |
boolean |
getPackageAsSourceOnlyLibrary() |
String |
getPassthroughField() |
String |
getPassthroughSuffix() |
Boolean |
getSagasAndRecords() |
String |
getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
Output the language-specific type declaration of the property.
|
Boolean |
getTypescriptThreePlus() |
Boolean |
getWithoutRuntimeChecks() |
boolean |
isUniqueIdAccordingToNameSuffix(String name) |
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) |
Map<String,Object> |
postProcessSupportingFileData(Map<String,Object> objs) |
void |
processOpts() |
void |
setDetectPassthroughModelsWithSuffixAndField(String detectPassthroughModelsWithSuffixAndField) |
void |
setInferEntityFromUniqueIdWithName(String inferEntityFromUniqueIdWithName) |
void |
setInferUniqueIdFromNameSuffix(boolean inferUniqueIdFromNameSuffix) |
void |
setNpmRepository(String npmRepository) |
void |
setPackageAsSourceOnlyLibrary(boolean packageAsSourceOnlyLibrary) |
void |
setSagasAndRecords(Boolean sagasAndRecords) |
void |
setTypescriptThreePlus(Boolean typescriptThreePlus) |
void |
setWithoutRuntimeChecks(Boolean withoutRuntimeChecks) |
String |
toEnumDefaultValue(String value,
String datatype)
Return the enum default value in the language specified format
|
addImport, addPrefix, addSuffix, apiFileFolder, escapeQuotationMark, escapeText, escapeUnsafeCharacters, getEnumPropertyNaming, getModelPropertyNaming, getNpmName, getNpmVersion, getNullSafeAdditionalProps, getParameterDataType, getParamNaming, getSchemaType, getSupportsES6, getTag, getTypesFromSchemas, isReservedWord, modelFileFolder, postProcessFile, preprocessOpenAPI, setEnumPropertyNaming, setModelPropertyNaming, setNpmName, setNpmVersion, setNullSafeAdditionalProps, setParamNaming, setSupportsES6, supportModelPropertyNaming, toAllOfName, toAnyOfName, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelFilename, toModelImport, toModelImportMap, toModelName, toOneOfName, toOperationId, toParamName, toTypescriptTypeName, toVarNameaddBodyModelSchema, addHeaders, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, embeddedTemplateDir, encodePath, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAdditionalProperties, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseOneOfInterfaces, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, needToImport, outputFolder, postProcess, postProcessModelProperty, postProcessModelsEnum, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterContentType, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelTestFilename, toRegularExpression, toSetter, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForObject, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForMap, updatePropertyForMap, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBackclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, getVersionMetadataFilename, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcess, postProcessModelProperty, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensionspublic static final String NPM_REPOSITORY
public static final String WITH_INTERFACES
public static final String USE_SINGLE_REQUEST_PARAMETER
public static final String PREFIX_PARAMETER_INTERFACES
public static final String TYPESCRIPT_THREE_PLUS
public static final String WITHOUT_RUNTIME_CHECKS
protected String npmRepository
protected boolean addedApiIndex
protected boolean addedModelIndex
protected boolean typescriptThreePlus
protected boolean withoutRuntimeChecks
public static final String SAGAS_AND_RECORDS
public static final String DETECT_PASSTHROUGH_MODELS_WITH_SUFFIX_AND_FIELD
public static final String INFER_UNIQUE_ID_FROM_NAME_SUFFIX
public static final String INFER_ENTITY_FROM_UNIQUE_ID_WITH_NAME
public static final String PACKAGE_AS_SOURCE_ONLY_LIBRARY
protected boolean sagasAndRecords
protected String detectPassthroughModelsWithSuffixAndField
protected boolean inferUniqueIdFromNameSuffix
protected String inferEntityFromUniqueIdWithName
protected boolean packageAsSourceOnlyLibrary
public String getName()
getName in interface CodegenConfiggetName in class DefaultCodegenpublic String getHelp()
getHelp in interface CodegenConfiggetHelp in class DefaultCodegenpublic String getNpmRepository()
public void setNpmRepository(String npmRepository)
public Boolean getTypescriptThreePlus()
public void setTypescriptThreePlus(Boolean typescriptThreePlus)
public Boolean getWithoutRuntimeChecks()
public void setWithoutRuntimeChecks(Boolean withoutRuntimeChecks)
public Boolean getSagasAndRecords()
public void setSagasAndRecords(Boolean sagasAndRecords)
public String getPassthroughSuffix()
public String getPassthroughField()
public String getDetectPassthroughModelsWithSuffixAndField()
public void setDetectPassthroughModelsWithSuffixAndField(String detectPassthroughModelsWithSuffixAndField)
public boolean getInferUniqueIdFromNameSuffix()
public void setInferUniqueIdFromNameSuffix(boolean inferUniqueIdFromNameSuffix)
public String getInferEntityFromUniqueIdWithName()
public void setInferEntityFromUniqueIdWithName(String inferEntityFromUniqueIdWithName)
public boolean getPackageAsSourceOnlyLibrary()
public void setPackageAsSourceOnlyLibrary(boolean packageAsSourceOnlyLibrary)
public boolean isUniqueIdAccordingToNameSuffix(String name)
public void processOpts()
processOpts in interface CodegenConfigprocessOpts in class AbstractTypeScriptClientCodegenpublic String toEnumDefaultValue(String value, String datatype)
DefaultCodegentoEnumDefaultValue in class AbstractTypeScriptClientCodegenvalue - enum variable namedatatype - data typeprotected String getEnumDefaultValue(String defaultValue, String dataType)
getEnumDefaultValue in class DefaultCodegenprotected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> addMustacheLambdas()
DefaultCodegenaddMustacheLambdas in class DefaultCodegenpublic String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetTypeDeclaration in interface CodegenConfiggetTypeDeclaration in class AbstractTypeScriptClientCodegenp - property schemaprotected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegenaddAdditionPropertiesToCodeGenModel in class DefaultCodegencodegenModel - The codegen representation of the schema.schema - The input OAS schema.public Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels in interface CodegenConfigpostProcessModels in class AbstractTypeScriptClientCodegenpublic void postProcessParameter(CodegenParameter parameter)
postProcessParameter in interface CodegenConfigpostProcessParameter in class DefaultCodegenpublic Map<String,Object> postProcessAllModels(Map<String,Object> objs)
postProcessAllModels in interface CodegenConfigpostProcessAllModels in class AbstractTypeScriptClientCodegenpublic List<CodegenParameter> fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports)
fromRequestBodyToFormParameters in class DefaultCodegenpublic org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter,
Set<String> imports)
DefaultCodegenfromParameter in class DefaultCodegenparameter - OAS parameter objectimports - set of imports for library/package/modulepublic CodegenParameter fromFormProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema, Set<String> imports)
fromFormProperty in class DefaultCodegenpublic CodegenParameter fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports, String bodyParameterName)
fromRequestBody in class DefaultCodegenpublic org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenProperty fromProperty(String name, io.swagger.v3.oas.models.media.Schema p)
DefaultCodegenfromProperty in class DefaultCodegenname - name of the propertyp - OAS property schemapublic org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema model)
DefaultCodegenfromModel in interface CodegenConfigfromModel in class DefaultCodegenname - the name of the modelmodel - OAS Model objectpublic org.openapitools.codegen.languages.TypeScriptFetchClientCodegen.ExtendedCodegenOperation fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers)
DefaultCodegenfromOperation in interface CodegenConfigfromOperation in class DefaultCodegenpath - the path of the operationhttpMethod - HTTP methodoperation - OAS operation objectservers - list of serverspublic String escapeReservedWord(String name)
DefaultCodegenescapeReservedWord in interface CodegenConfigescapeReservedWord in class AbstractTypeScriptClientCodegenname - the name to be escapedthrows Runtime exception as reserved word is not allowed (default behavior)
public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> operations, List<Object> allModels)
postProcessOperationsWithModels in interface CodegenConfigpostProcessOperationsWithModels in class DefaultCodegenpublic Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
postProcessSupportingFileData in interface CodegenConfigpostProcessSupportingFileData in class DefaultCodegenCopyright © 2021. All rights reserved.