Package org.openapitools.codegen.languages

Class PostmanCollectionCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.PostmanCollectionCodegen

All Implemented Interfaces:

CodegenConfig

public class PostmanCollectionCodegen
extends DefaultCodegen
implements CodegenConfig

OpenAPI generator for Postman Collection format v2.1

Mustache templates are located in src/main/resources/postman-collection/.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PostmanCollectionCodegen.PostmanRequestFolder
class	PostmanCollectionCodegen.PostmanRequestItem
class	PostmanCollectionCodegen.PostmanResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiVersion
Map<PostmanCollectionCodegen.PostmanRequestFolder,List<CodegenOperation>>	codegenOperationsByTag
List<CodegenOperation>	codegenOperationsList
static String	FOLDER_STRATEGY
static String	FOLDER_STRATEGY_DEFAULT_VALUE
String	folderStrategy
static String	JSON_ESCAPE_DOUBLE_QUOTE
static String	JSON_ESCAPE_NEW_LINE
static String	PATH_PARAMS_AS_VARIABLES
static Boolean	PATH_PARAMS_AS_VARIABLES_DEFAULT_VALUE
protected Boolean	pathParamsAsVariables
static String	POSTMAN_FILE_DEFAULT_VALUE
static String	POSTMAN_GUID
static String	POSTMAN_GUID_PLACEHOLDER_NAME
protected static String	POSTMAN_GUID_PLACEHOLDER_NAME_DEFAULT_VALUE
static String	POSTMAN_ISO_TIMESTAMP
static String	POSTMAN_ISO_TIMESTAMP_PLACEHOLDER_NAME
static String	POSTMAN_ISO_TIMESTAMP_PLACEHOLDER_NAME_DEFAULT_VALUE
static String	POSTMAN_VARIABLES
String	postmanFile
protected Boolean	postmanGuid
protected static String	postmanGuidPlaceholderName
protected Boolean	postmanIsoTimestamp
protected static String	postmanIsoTimestampPlaceholderName
protected Boolean	postmanVariables
static String	REQUEST_PARAMETER_GENERATION
static String	REQUEST_PARAMETER_GENERATION_DEFAULT_VALUE
protected String	requestParameterGeneration
Set<org.openapitools.codegen.languages.PostmanCollectionCodegen.PostmanVariable>	variables

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, defaultToEmptyContainer, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumNameMapping, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, skipSortingOperations, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, SPLIT_ON_SEMICOLON_OR_NEWLINE_REGEX, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN

Constructor Summary

Constructors

Constructor	Description
PostmanCollectionCodegen()

Method Summary

Modifier and Type	Method	Description
void	addToList(CodegenOperation codegenOperation)
void	addToMap(CodegenOperation codegenOperation)	Add the CodegenOperation to the map that is passed to the Mustache templates The map groups the CodegenOperations by tag as defined in the OpenAPI spec
String	convertToJson(com.fasterxml.jackson.databind.node.ObjectNode objectNode)
String	convertToJson(LinkedHashMap<String,Object> linkedHashMap)
List<PostmanCollectionCodegen.PostmanRequestItem>	createPostmanVariables(List<PostmanCollectionCodegen.PostmanRequestItem> postmanRequests)
String	escapeQuotationMark(String input)	Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name)	Escapes a reserved word as defined in the `reservedWords` array.
String	escapeUnsafeCharacters(String input)	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
String	extractExampleByName(String ref)
Set<String>	extractPlaceholders(String input)	Extract all placeholders (string delimited by curly braces ie {{PLACEHOLDER}}) from the input string
String	formatDescription(String description)	Format text to include in JSON file
String	formatJson(String json)
List<CodegenServerVariable>	fromServerVariables(Map<String,io.swagger.v3.oas.models.servers.ServerVariable> variables)
GeneratorLanguage	generatorLanguage()
String[]	getAttributes(String json)
String	getHelp()	Returns human-friendly help for the generator.
String	getJsonFromExample(io.swagger.v3.oas.models.examples.Example example)
String	getJsonFromSchema(CodegenParameter codegenParameter)
String	getName()	Configures a friendly name for the generator.
String	getPostmanType(CodegenProperty codegenProperty)
CodegenType	getTag()	Configures the type of generator.
boolean	isPostmanDynamicVariable(String value)
String	mapToPostmanType(String openApiDataType)
OperationsMap	postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)	Process and modify operations before generating code
void	postProcessParameter(CodegenParameter parameter)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)	Return the default value of the property

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, convertPropertyToBooleanAndWriteBack, convertPropertyToStringAndWriteBack, convertPropertyToTypeAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextInSingleQuotes, escapeTextWhileAllowingNewLines, executePostProcessor, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDiscriminatorPropertyType, getDiscriminatorSchema, getDocExtension, getEnumDefaultValue, getEnumUnknownDefaultCase, getEnumValueForProperty, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNameToSchemaCache, getMostInnerItems, getObjectAsStringList, getObjectAsStringListMap, getObjectAsStringMap, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getProducesInfo, getPropertyAsStringList, getPropertyAsStringListMap, getPropertyAsStringMap, getReleaseNote, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaType, getSingleSchemaType, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, nameMapping, needToImport, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessEnumVars, postProcessFile, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setCircularReferences, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnumDiscriminatorDefaultValue, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, setUseOneOfInterfaces, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelFilename, toModelImport, toModelImportMap, toModelName, toModelTestFilename, toOneOfName, toOperationId, toParamName, toRegularExpression, toSetter, toTestCaseName, toVarName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, useCodegenAsMustacheParentContext, vendorExtensions, 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, apiFileFolder, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImport, toModelImportMap, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

Field Detail

apiVersion

protected String apiVersion

FOLDER_STRATEGY

public static final String FOLDER_STRATEGY

See Also:

Constant Field Values

FOLDER_STRATEGY_DEFAULT_VALUE

public static final String FOLDER_STRATEGY_DEFAULT_VALUE

See Also:

Constant Field Values

PATH_PARAMS_AS_VARIABLES

public static final String PATH_PARAMS_AS_VARIABLES

See Also:

Constant Field Values

PATH_PARAMS_AS_VARIABLES_DEFAULT_VALUE

public static final Boolean PATH_PARAMS_AS_VARIABLES_DEFAULT_VALUE

POSTMAN_FILE_DEFAULT_VALUE

public static final String POSTMAN_FILE_DEFAULT_VALUE

See Also:

Constant Field Values

POSTMAN_VARIABLES

public static final String POSTMAN_VARIABLES

See Also:

Constant Field Values

postmanVariables

protected Boolean postmanVariables

POSTMAN_GUID

public static final String POSTMAN_GUID

See Also:

Constant Field Values

postmanGuid

protected Boolean postmanGuid

POSTMAN_GUID_PLACEHOLDER_NAME

public static final String POSTMAN_GUID_PLACEHOLDER_NAME

See Also:

Constant Field Values

POSTMAN_GUID_PLACEHOLDER_NAME_DEFAULT_VALUE

protected static final String POSTMAN_GUID_PLACEHOLDER_NAME_DEFAULT_VALUE

See Also:

Constant Field Values

postmanGuidPlaceholderName

protected static String postmanGuidPlaceholderName

postmanIsoTimestamp

protected Boolean postmanIsoTimestamp

POSTMAN_ISO_TIMESTAMP

public static final String POSTMAN_ISO_TIMESTAMP

See Also:

Constant Field Values

POSTMAN_ISO_TIMESTAMP_PLACEHOLDER_NAME

public static final String POSTMAN_ISO_TIMESTAMP_PLACEHOLDER_NAME

See Also:

Constant Field Values

POSTMAN_ISO_TIMESTAMP_PLACEHOLDER_NAME_DEFAULT_VALUE

public static final String POSTMAN_ISO_TIMESTAMP_PLACEHOLDER_NAME_DEFAULT_VALUE

See Also:

Constant Field Values

postmanIsoTimestampPlaceholderName

protected static String postmanIsoTimestampPlaceholderName

REQUEST_PARAMETER_GENERATION

public static final String REQUEST_PARAMETER_GENERATION

See Also:

Constant Field Values

REQUEST_PARAMETER_GENERATION_DEFAULT_VALUE

public static final String REQUEST_PARAMETER_GENERATION_DEFAULT_VALUE

See Also:

Constant Field Values

folderStrategy

public String folderStrategy

pathParamsAsVariables

protected Boolean pathParamsAsVariables

postmanFile

public String postmanFile

requestParameterGeneration

protected String requestParameterGeneration

variables

public Set<org.openapitools.codegen.languages.PostmanCollectionCodegen.PostmanVariable> variables

JSON_ESCAPE_DOUBLE_QUOTE

public static final String JSON_ESCAPE_DOUBLE_QUOTE

See Also:

Constant Field Values

JSON_ESCAPE_NEW_LINE

public static final String JSON_ESCAPE_NEW_LINE

See Also:

Constant Field Values

codegenOperationsByTag

public Map<PostmanCollectionCodegen.PostmanRequestFolder,List<CodegenOperation>> codegenOperationsByTag

codegenOperationsList

public List<CodegenOperation> codegenOperationsList

Constructor Detail

PostmanCollectionCodegen

public PostmanCollectionCodegen()

Method Detail

getTag

public CodegenType getTag()

Configures the type of generator.

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

Returns:

the CodegenType for this generator

See Also:

CodegenType

generatorLanguage

public GeneratorLanguage generatorLanguage()

Specified by:

generatorLanguage in interface CodegenConfig

Overrides:

generatorLanguage in class DefaultCodegen

getName

public String getName()

Configures a friendly name for the generator. This will be used by the generator to select the library with the -g flag.

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

Returns:

the friendly name for the generator

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

preprocessOpenAPI

public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Specified by:

preprocessOpenAPI in interface CodegenConfig

Overrides:

preprocessOpenAPI in class DefaultCodegen

fromServerVariables

public List<CodegenServerVariable> fromServerVariables(Map<String,io.swagger.v3.oas.models.servers.ServerVariable> variables)

Specified by:

fromServerVariables in interface CodegenConfig

Overrides:

fromServerVariables in class DefaultCodegen

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

postProcessOperationsWithModels

public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)

Process and modify operations before generating code

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

addToMap

public void addToMap(CodegenOperation codegenOperation)

Add the CodegenOperation to the map that is passed to the Mustache templates The map groups the CodegenOperations by tag as defined in the OpenAPI spec

Parameters:

codegenOperation - Codegen operation instance

addToList

public void addToList(CodegenOperation codegenOperation)

createPostmanVariables

public List<PostmanCollectionCodegen.PostmanRequestItem> createPostmanVariables(List<PostmanCollectionCodegen.PostmanRequestItem> postmanRequests)

getHelp

public String getHelp()

Returns human-friendly help for the generator. Provide the consumer with help tips, parameters here

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

Returns:

A string value for the help message

escapeReservedWord

public String escapeReservedWord(String name)

Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reserved words

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped term

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

Specified by:

escapeUnsafeCharacters in interface CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

toDefaultValue

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

Return the default value of the property

Return null when the default is not defined

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

schema - Property schema

Returns:

string presentation of the default value of the property

escapeQuotationMark

public String escapeQuotationMark(String input)

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

extractExampleByName

public String extractExampleByName(String ref)

mapToPostmanType

public String mapToPostmanType(String openApiDataType)

formatDescription

public String formatDescription(String description)

Format text to include in JSON file

Parameters:

description - Text to format

Returns:

Formatted text

extractPlaceholders

public Set<String> extractPlaceholders(String input)

Extract all placeholders (string delimited by curly braces ie {{PLACEHOLDER}}) from the input string

Parameters:

input - String containing the placeholders

Returns:

Set of placeholders found in the string

isPostmanDynamicVariable

public boolean isPostmanDynamicVariable(String value)

getJsonFromSchema

public String getJsonFromSchema(CodegenParameter codegenParameter)

getJsonFromExample

public String getJsonFromExample(io.swagger.v3.oas.models.examples.Example example)

getAttributes

public String[] getAttributes(String json)

convertToJson

public String convertToJson(com.fasterxml.jackson.databind.node.ObjectNode objectNode)

convertToJson

public String convertToJson(LinkedHashMap<String,Object> linkedHashMap)

formatJson

public String formatJson(String json)

getPostmanType

public String getPostmanType(CodegenProperty codegenProperty)