org.openapitools.codegen

Class DefaultCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

AbstractAdaCodegen, AbstractApexCodegen, AbstractCppCodegen, AbstractCSharpCodegen, AbstractEiffelCodegen, AbstractFSharpCodegen, AbstractGoCodegen, AbstractGraphQLCodegen, AbstractJavaCodegen, AbstractKotlinCodegen, AbstractPhpCodegen, AbstractRubyCodegen, AbstractScalaCodegen, AbstractTypeScriptClientCodegen, AndroidClientCodegen, Apache2ConfigCodegen, BashClientCodegen, CLibcurlClientCodegen, ClojureClientCodegen, ConfluenceWikiCodegen, DartClientCodegen, ElixirClientCodegen, ElmClientCodegen, ErlangClientCodegen, ErlangProperCodegen, ErlangServerCodegen, FinchServerCodegen, FlashClientCodegen, HaskellHttpClientCodegen, HaskellServantCodegen, JavascriptClientCodegen, JavascriptClosureAngularClientCodegen, JMeterClientCodegen, LuaClientCodegen, MysqlSchemaCodegen, NodeJSServerCodegen, ObjcClientCodegen, OpenAPIGenerator, OpenAPIYamlGenerator, PerlClientCodegen, PhpSilexServerCodegen, PowerShellClientCodegen, PythonAbstractConnexionServerCodegen, PythonClientCodegen, RClientCodegen, RustClientCodegen, RustServerCodegen, StaticDocCodegen, StaticHtml2Generator, StaticHtmlGenerator, Swift3Codegen, Swift4Codegen, SwiftClientCodegen

public class DefaultCodegen
extends Object
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	additionalProperties
protected Boolean	allowUnicodeIdentifiers
protected Map<String,String>	apiDocTemplateFiles
protected String	apiPackage
protected Map<String,String>	apiTemplateFiles
protected Map<String,String>	apiTestTemplateFiles
protected List<CliOption>	cliOptions
protected String	commonTemplateDir
protected Set<String>	defaultIncludes
protected String	docExtension
protected String	embeddedTemplateDir
protected boolean	enableMinimalUpdate
protected boolean	enablePostProcessFile
protected Boolean	ensureUniqueParams
protected String	fileSuffix
protected GeneratorMetadata	generatorMetadata
protected String	gitRepoId
protected String	gitUserId
protected Boolean	hideGenerationTimestamp
protected String	httpUserAgent
protected String	ignoreFilePathOverride
protected Map<String,String>	importMapping
protected String	inputSpec
protected Map<String,String>	instantiationTypes
protected Set<String>	languageSpecificPrimitives
protected String	library
protected Map<String,String>	modelDocTemplateFiles
protected String	modelNamePrefix
protected String	modelNameSuffix
protected String	modelPackage
protected Map<String,String>	modelTemplateFiles
protected Map<String,String>	modelTestTemplateFiles
protected io.swagger.v3.oas.models.OpenAPI	openAPI
protected String	outputFolder
protected Boolean	prependFormOrBodyParameters
protected String	releaseNote
protected boolean	removeOperationIdPrefix
protected Set<String>	reservedWords
protected Map<String,String>	reservedWordsMappings
protected boolean	skipOverwrite
protected Boolean	sortParamsByRequiredFlag
protected Map<String,String>	specialCharReplacements
protected boolean	strictSpecBehavior
protected Map<String,String>	supportedLibraries
protected List<SupportingFile>	supportingFiles
protected boolean	supportsInheritance
protected boolean	supportsMixins
protected boolean	supportsMultipleInheritance
protected String	templateDir
protected String	testPackage
protected Map<String,String>	typeAliases
protected Map<String,String>	typeMapping
protected Map<String,Object>	vendorExtensions

Constructor Summary

Constructors

Constructor and Description
DefaultCodegen() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)
protected void	addImport(CodegenModel m, String type)
Map<String,Object>	additionalProperties()
void	addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations) Add operation to group
protected void	addOption(String key, String description, String defaultValue)
protected void	addProperties(Map<String,io.swagger.v3.oas.models.media.Schema> properties, List<String> required, io.swagger.v3.oas.models.media.Schema schema) Add schema's properties to "properties" and "required" list
String	addRegularExpressionDelimiter(String pattern) If the pattern misses the delimiter, add "/" to the beginning and end Otherwise, return the original pattern
protected void	addSwitch(String key, String description, Boolean defaultValue)
String	apiDocFileFolder()
String	apiDocFilename(String templateName, String tag) Return the full path and API documentation file
Map<String,String>	apiDocTemplateFiles()
String	apiFileFolder()
String	apiFilename(String templateName, String tag)
String	apiPackage()
Map<String,String>	apiTemplateFiles()
String	apiTestFileFolder()
String	apiTestFilename(String templateName, String tag) Return the full path and API test file
Map<String,String>	apiTestTemplateFiles()
protected CliOption	buildLibraryCliOption(Map<String,String> supportedLibraries)
List<CliOption>	cliOptions()
boolean	convertPropertyToBoolean(String propertyKey)
boolean	convertPropertyToBooleanAndWriteBack(String propertyKey) reads propertyKey from additionalProperties, converts it to a boolean and writes it back to additionalProperties to be usable as a boolean in mustache files.
Set<String>	defaultIncludes()
String	embeddedTemplateDir()
String	encodePath(String input)
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name) Return the escaped name of the reserved word
String	escapeText(String input)
String	escapeTextWhileAllowingNewLines(String input) Escape characters while allowing new lines
String	escapeUnsafeCharacters(String input) override with any special text escaping logic to handle unsafe characters so as to avoid code injection
String	fileSuffix()
String	findCommonPrefixOfVars(List<Object> vars) Returns the common prefix of variables for enum naming if two or more variables are present
protected io.swagger.v3.oas.models.responses.ApiResponse	findMethodResponse(io.swagger.v3.oas.models.responses.ApiResponses responses) Override with any special handling of response codes
CodegenCallback	fromCallback(String name, io.swagger.v3.oas.models.callbacks.Callback callback, List<io.swagger.v3.oas.models.servers.Server> servers) Convert OAS Callback object to Codegen Callback object
CodegenParameter	fromFormProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema, Set<String> imports)
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema) Convert OAS Model object to Codegen Model object
CodegenOperation	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
CodegenParameter	fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter, Set<String> imports) Convert OAS Parameter object to Codegen Parameter object
CodegenProperty	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)
CodegenResponse	fromResponse(String responseCode, io.swagger.v3.oas.models.responses.ApiResponse response) Convert OAS Response object to Codegen Response object
List<CodegenSecurity>	fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> securitySchemeMap) Convert map of OAS SecurityScheme objects to a list of Codegen Security objects
List<CodegenServer>	fromServers(List<io.swagger.v3.oas.models.servers.Server> servers)
List<CodegenServerVariable>	fromServerVariables(Map<String,io.swagger.v3.oas.models.servers.ServerVariable> variables)
String	generateExamplePath(String path, io.swagger.v3.oas.models.Operation operation) Return the example path
void	generateJSONSpecFile(Map<String,Object> objs) generates OpenAPI specification file in JSON format
void	generateYAMLSpecFile(Map<String,Object> objs) generates OpenAPI specification file in YAML format
String	getAlias(String name) Determine the type alias for the given type if it exists.
Boolean	getAllowUnicodeIdentifiers()
protected String	getCollectionFormat(io.swagger.v3.oas.models.parameters.Parameter parameter)
String	getCommonTemplateDir()
static Set<String>	getConsumesInfo(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation)
protected String	getContentType(io.swagger.v3.oas.models.parameters.RequestBody requestBody)
String	getDocExtension() Documentation files extension
Boolean	getEnsureUniqueParams()
GeneratorMetadata	getGeneratorMetadata() Returns metadata about the generator.
String	getGitRepoId() Git repo ID
String	getGitUserId() Git user ID
String	getHelp()
String	getHttpUserAgent() HTTP user agent
String	getIgnoreFilePathOverride() Provides an override location, if any is specified, for the .openapi-generator-ignore.
protected Map<String,Object>	getInnerEnumAllowableValues(CodegenProperty property)
String	getInputSpec()
String	getLibrary() Library template (sub-template).
String	getModelNamePrefix()
String	getModelNameSuffix()
protected CodegenProperty	getMostInnerItems(CodegenProperty property)
String	getName()
protected String	getOrGenerateOperationId(io.swagger.v3.oas.models.Operation operation, String path, String httpMethod) Get operationId from the operation object, and if it's blank, generate a new one from the given parameters.
String	getOutputDir()
protected String	getParameterDataType(io.swagger.v3.oas.models.parameters.Parameter parameter, io.swagger.v3.oas.models.media.Schema schema) Returns the data type of a parameter.
Boolean	getPrependFormOrBodyParameters()
static Set<String>	getProducesInfo(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation) returns the list of MIME types the APIs can produce
String	getReleaseNote() Release note
String	getSchemaType(io.swagger.v3.oas.models.media.Schema schema) returns the OpenAPI type for the property.
Boolean	getSortParamsByRequiredFlag()
protected String	getSymbolName(String input) Return the symbol name of a symbol
CodegenType	getTag()
TemplatingEngineAdapter	getTemplatingEngine()
String	getterAndSetterCapitalize(String name) Camelize the method name of the getter and setter
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema) Output the type declaration of the property
String	getTypeDeclaration(String name) Output the type declaration of a given name
boolean	hasBodyParameter(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation)
boolean	hasFormParameter(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation)
Map<String,String>	importMapping()
protected void	initalizeSpecialCharacterMapping() Initialize special character mapping
Map<String,String>	instantiationTypes()
boolean	isDataTypeBinary(String dataType)
boolean	isDataTypeFile(String dataType)
boolean	isDataTypeString(String dataType) checks if the data should be classified as "string" in enum e.g.
boolean	isEnableMinimalUpdate() Get the boolean value indicating the state of the option for updating only changed files
boolean	isEnablePostProcessFile() Boolean value indicating the state of the option for post-processing file using envirionment variables.
boolean	isHideGenerationTimestamp()
boolean	isParameterNameUnique(CodegenParameter p, List<CodegenParameter> parameters)
protected Boolean	isPropertyInnerMostEnum(CodegenProperty property) Update property for map container
boolean	isRemoveOperationIdPrefix()
protected boolean	isReservedWord(String word)
boolean	isSkipOverwrite()
boolean	isStrictSpecBehavior() Indicates whether the codegen configuration should treat documents as strictly defined by the OpenAPI specification.
Set<String>	languageSpecificPrimitives()
String	modelDocFileFolder()
Map<String,String>	modelDocTemplateFiles()
String	modelFileFolder()
String	modelPackage()
Map<String,String>	modelTemplateFiles()
String	modelTestFileFolder()
Map<String,String>	modelTestTemplateFiles()
protected boolean	needToImport(String type) Check the type to see if it needs import the library/module/package
String	outputFolder()
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessFile(File file, String fileType) Post-process the auto-generated file, e.g.
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessModelsEnum(Map<String,Object> objs) post process enum defined in model's properties
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	postProcessParameter(CodegenParameter parameter)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
com.samskivert.mustache.Mustache.Compiler	processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)
void	processOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
TemplatingEngineAdapter	processTemplatingEngine(TemplatingEngineAdapter templatingEngine)
String	removeNonNameElementToCamelCase(String name) Remove characters not suitable for variable or method name from the input and camelize it
protected String	removeNonNameElementToCamelCase(String name, String nonNameElementPattern) Remove characters that is not good to be included in method name from the input and camelize it
Set<String>	reservedWords()
Map<String,String>	reservedWordsMappings()
String	sanitizeName(String name) Sanitize name (parameter, property, method, etc)
String	sanitizeName(String name, String removeCharRegEx) Sanitize name (parameter, property, method, etc)
String	sanitizeTag(String tag) Sanitize tag
void	setAllowUnicodeIdentifiers(Boolean allowUnicodeIdentifiers)
void	setApiPackage(String apiPackage)
void	setCommonTemplateDir(String commonTemplateDir)
void	setDocExtension(String userDocExtension) Set Documentation files extension
void	setEnableMinimalUpdate(boolean enableMinimalUpdate) Set the boolean value indicating the state of the option for updating only changed files
void	setEnablePostProcessFile(boolean enablePostProcessFile) Set the boolean value indicating the state of the option for post-processing file using envirionment variables.
void	setEnsureUniqueParams(Boolean ensureUniqueParams)
void	setGitRepoId(String gitRepoId) Set Git repo ID.
void	setGitUserId(String gitUserId) Set Git user ID.
void	setHideGenerationTimestamp(boolean hideGenerationTimestamp)
void	setHttpUserAgent(String httpUserAgent) Set HTTP user agent.
void	setIgnoreFilePathOverride(String ignoreFileOverride) Sets an override location for the '.openapi-generator-ignore' location for the first code generation.
void	setInputSpec(String inputSpec)
void	setLibrary(String library) Set library template (sub-template).
void	setModelNamePrefix(String modelNamePrefix)
void	setModelNameSuffix(String modelNameSuffix)
void	setModelPackage(String modelPackage)
protected void	setNonArrayMapProperty(CodegenProperty property, String type)
void	setOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) Set the OpenAPI instance.
void	setOutputDir(String dir)
void	setParameterBooleanFlagWithCodegenProperty(CodegenParameter parameter, CodegenProperty property) Set CodegenParameter boolean flag using CodegenProperty.
void	setParameterExampleValue(CodegenParameter codegenParameter) Return the example value of the parameter.
void	setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter) Return the example value of the parameter.
void	setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.RequestBody requestBody) Return the example value of the parameter.
void	setPrependFormOrBodyParameters(Boolean prependFormOrBodyParameters)
void	setReleaseNote(String releaseNote) Set release note.
void	setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)
protected void	setReservedWordsLowerCase(List<String> words)
void	setSkipOverwrite(boolean skipOverwrite)
void	setSortParamsByRequiredFlag(Boolean sortParamsByRequiredFlag)
void	setStrictSpecBehavior(boolean strictSpecBehavior) Sets the boolean valid indicating whether generation will work strictly against the specification, potentially making minor changes to the input document.
void	setTemplateDir(String templateDir)
void	setTemplatingEngine(TemplatingEngineAdapter templatingEngine)
boolean	shouldOverwrite(String filename)
String	snakeCase(String name) Return the snake-case of the string
Map<String,String>	supportedLibraries() All library templates supported.
List<SupportingFile>	supportingFiles()
String	templateDir()
String	testPackage()
String	toAllOfName(List<String> names, io.swagger.v3.oas.models.media.ComposedSchema composedSchema) Return the name of the allOf schema
String	toAnyOfName(List<String> names, io.swagger.v3.oas.models.media.ComposedSchema composedSchema) Return the name of the anyOf schema
String	toApiDocFilename(String name) Return the file name of the Api Documentation
String	toApiFilename(String name) Return the file name of the Api Test
String	toApiImport(String name) Return the fully-qualified "Api" name for import
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toApiTestFilename(String name) Return the file name of the Api Test
String	toApiVarName(String name) Return the variable name in the Api
String	toArrayModelParamName(String name) Return the parameter name of array of model
String	toBooleanGetter(String name) Output the Getter name for boolean property, e.g.
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema schema) Return the default value of the property
String	toDefaultValueWithParam(String name, io.swagger.v3.oas.models.media.Schema schema) Return the property initialized from a data object Useful for initialization with a plain object in Javascript
String	toEnumDefaultValue(String value, String datatype) Return the enum default value in the language specified format
String	toEnumName(CodegenProperty property) Return the Enum name (e.g.
String	toEnumValue(String value, String datatype) Return the enum value in the language specified format e.g.
String	toEnumVarName(String value, String datatype) Return the sanitized variable name for enum
protected List<Map<String,Object>>	toExamples(Map<String,Object> examples)
String	toExampleValue(io.swagger.v3.oas.models.media.Schema schema) Return the example value of the property
String	toGetter(String name) Output the Getter name, e.g.
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema schema) Return the instantiation type of the property, especially for map and array
String	toModelDocFilename(String name) Return the capitalized file name of the model documentation
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelImport(String name) Return the fully-qualified "Model" name for import
String	toModelName(String name) Output the proper model name (capitalized).
String	toModelTestFilename(String name) Return the capitalized file name of the model test
String	toOneOfName(List<String> names, io.swagger.v3.oas.models.media.ComposedSchema composedSchema) Return the name of the oneOf schema
String	toOperationId(String operationId) Return the operation ID (method name)
String	toParamName(String name) Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
String	toRegularExpression(String pattern) Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
String	toSetter(String name) Output the Setter name, e.g.
String	toVarName(String name) Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
Map<String,String>	typeMapping()
Map<String,Object>	updateAllModels(Map<String,Object> objs) Loop through all models to update different flags (e.g.
void	updateCodegenPropertyEnum(CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)
protected void	updateDataTypeWithEnumForArray(CodegenProperty property) Update datatypeWithEnum for array container
protected void	updateDataTypeWithEnumForMap(CodegenProperty property) Update datatypeWithEnum for map container
protected void	updateOption(String key, String defaultValue)
protected void	updatePropertyForArray(CodegenProperty property, CodegenProperty innerProperty) Update property for array(list) container
protected void	updatePropertyForMap(CodegenProperty property, CodegenProperty innerProperty) Update property for map container
Map<String,Object>	vendorExtensions()
void	writeOptional(String outputFolder, SupportingFile supportingFile) Only write if the file doesn't exist
void	writePropertyBack(String propertyKey, boolean value)

Methods inherited from class java.lang.Object

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

Field Detail

generatorMetadata

protected GeneratorMetadata generatorMetadata

inputSpec

protected String inputSpec

outputFolder

protected String outputFolder

defaultIncludes

protected Set<String> defaultIncludes

typeMapping

protected Map<String,String> typeMapping

instantiationTypes

protected Map<String,String> instantiationTypes

reservedWords

protected Set<String> reservedWords

languageSpecificPrimitives

protected Set<String> languageSpecificPrimitives

importMapping

protected Map<String,String> importMapping

modelPackage

protected String modelPackage

apiPackage

protected String apiPackage

fileSuffix

protected String fileSuffix

modelNamePrefix

protected String modelNamePrefix

modelNameSuffix

protected String modelNameSuffix

testPackage

protected String testPackage

apiTemplateFiles

protected Map<String,String> apiTemplateFiles

modelTemplateFiles

protected Map<String,String> modelTemplateFiles

apiTestTemplateFiles

protected Map<String,String> apiTestTemplateFiles

modelTestTemplateFiles

protected Map<String,String> modelTestTemplateFiles

apiDocTemplateFiles

protected Map<String,String> apiDocTemplateFiles

modelDocTemplateFiles

protected Map<String,String> modelDocTemplateFiles

reservedWordsMappings

protected Map<String,String> reservedWordsMappings

templateDir

protected String templateDir

embeddedTemplateDir

protected String embeddedTemplateDir

commonTemplateDir

protected String commonTemplateDir

additionalProperties

protected Map<String,Object> additionalProperties

vendorExtensions

protected Map<String,Object> vendorExtensions

supportingFiles

protected List<SupportingFile> supportingFiles

cliOptions

protected List<CliOption> cliOptions

skipOverwrite

protected boolean skipOverwrite

removeOperationIdPrefix

protected boolean removeOperationIdPrefix

supportsMultipleInheritance

protected boolean supportsMultipleInheritance

supportsInheritance

protected boolean supportsInheritance

supportsMixins

protected boolean supportsMixins

supportedLibraries

protected Map<String,String> supportedLibraries

library

protected String library

sortParamsByRequiredFlag

protected Boolean sortParamsByRequiredFlag

ensureUniqueParams

protected Boolean ensureUniqueParams

allowUnicodeIdentifiers

protected Boolean allowUnicodeIdentifiers

gitUserId

protected String gitUserId

gitRepoId

protected String gitRepoId

releaseNote

protected String releaseNote

httpUserAgent

protected String httpUserAgent

hideGenerationTimestamp

protected Boolean hideGenerationTimestamp

specialCharReplacements

protected Map<String,String> specialCharReplacements

typeAliases

protected Map<String,String> typeAliases

prependFormOrBodyParameters

protected Boolean prependFormOrBodyParameters

docExtension

protected String docExtension

ignoreFilePathOverride

protected String ignoreFilePathOverride

enablePostProcessFile

protected boolean enablePostProcessFile

enableMinimalUpdate

protected boolean enableMinimalUpdate

strictSpecBehavior

protected boolean strictSpecBehavior

openAPI

protected io.swagger.v3.oas.models.OpenAPI openAPI

Constructor Detail

DefaultCodegen

public DefaultCodegen()

Default constructor. This method will map between OAS type and language-specified type, as well as mapping between OAS type and the corresponding import statement for the language. This will also add some language specified CLI options, if any. returns string presentation of the example path (it's a constructor)

Method Detail

cliOptions

public List<CliOption> cliOptions()

Specified by:

cliOptions in interface CodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

postProcessAllModels

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

Specified by:

postProcessAllModels in interface CodegenConfig

updateAllModels

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

Loop through all models to update different flags (e.g. isSelfReference), children models, etc

Specified by:

updateAllModels in interface CodegenConfig

Parameters:

objs - Map of models

Returns:

maps of models with various updates

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

postProcessModelsEnum

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

post process enum defined in model's properties

Parameters:

objs - Map of models

Returns:

maps of models with better enum support

findCommonPrefixOfVars

public String findCommonPrefixOfVars(List<Object> vars)

Returns the common prefix of variables for enum naming if two or more variables are present

Parameters:

vars - List of variable names

Returns:

the common prefix for naming

toEnumDefaultValue

public String toEnumDefaultValue(String value,
                                 String datatype)

Return the enum default value in the language specified format

Parameters:

value - enum variable name

datatype - data type

Returns:

the default value for the enum

toEnumValue

public String toEnumValue(String value,
                          String datatype)

Return the enum value in the language specified format e.g. status becomes "status"

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

toEnumVarName

public String toEnumVarName(String value,
                            String datatype)

Return the sanitized variable name for enum

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

setOpenAPI

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

Description copied from interface: CodegenConfig

Set the OpenAPI instance. This method needs to be called right after the instantiation of the Codegen class.

Specified by:

setOpenAPI in interface CodegenConfig

Parameters:

openAPI - specification being generated

postProcessOperationsWithModels

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

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

postProcessSupportingFileData

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

Specified by:

postProcessSupportingFileData in interface CodegenConfig

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

Specified by:

postProcessModelProperty in interface CodegenConfig

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Specified by:

postProcessParameter in interface CodegenConfig

preprocessOpenAPI

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

Specified by:

preprocessOpenAPI in interface CodegenConfig

processOpenAPI

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

Specified by:

processOpenAPI in interface CodegenConfig

processCompiler

public com.samskivert.mustache.Mustache.Compiler processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)

Specified by:

processCompiler in interface CodegenConfig

processTemplatingEngine

public TemplatingEngineAdapter processTemplatingEngine(TemplatingEngineAdapter templatingEngine)

Specified by:

processTemplatingEngine in interface CodegenConfig

escapeText

public String escapeText(String input)

Specified by:

escapeText in interface CodegenConfig

escapeTextWhileAllowingNewLines

public String escapeTextWhileAllowingNewLines(String input)

Escape characters while allowing new lines

Specified by:

escapeTextWhileAllowingNewLines in interface CodegenConfig

Parameters:

input - String to be escaped

Returns:

escaped string

encodePath

public String encodePath(String input)

Specified by:

encodePath in interface CodegenConfig

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

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

escapeQuotationMark

public String escapeQuotationMark(String input)

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface CodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

defaultIncludes

public Set<String> defaultIncludes()

Specified by:

defaultIncludes in interface CodegenConfig

typeMapping

public Map<String,String> typeMapping()

Specified by:

typeMapping in interface CodegenConfig

instantiationTypes

public Map<String,String> instantiationTypes()

Specified by:

instantiationTypes in interface CodegenConfig

reservedWords

public Set<String> reservedWords()

Specified by:

reservedWords in interface CodegenConfig

languageSpecificPrimitives

public Set<String> languageSpecificPrimitives()

Specified by:

languageSpecificPrimitives in interface CodegenConfig

importMapping

public Map<String,String> importMapping()

Specified by:

importMapping in interface CodegenConfig

testPackage

public String testPackage()

Specified by:

testPackage in interface CodegenConfig

modelPackage

public String modelPackage()

Specified by:

modelPackage in interface CodegenConfig

apiPackage

public String apiPackage()

Specified by:

apiPackage in interface CodegenConfig

fileSuffix

public String fileSuffix()

Specified by:

fileSuffix in interface CodegenConfig

templateDir

public String templateDir()

Specified by:

templateDir in interface CodegenConfig

embeddedTemplateDir

public String embeddedTemplateDir()

Specified by:

embeddedTemplateDir in interface CodegenConfig

getCommonTemplateDir

public String getCommonTemplateDir()

Specified by:

getCommonTemplateDir in interface CodegenConfig

setCommonTemplateDir

public void setCommonTemplateDir(String commonTemplateDir)

apiDocTemplateFiles

public Map<String,String> apiDocTemplateFiles()

Specified by:

apiDocTemplateFiles in interface CodegenConfig

modelDocTemplateFiles

public Map<String,String> modelDocTemplateFiles()

Specified by:

modelDocTemplateFiles in interface CodegenConfig

reservedWordsMappings

public Map<String,String> reservedWordsMappings()

Specified by:

reservedWordsMappings in interface CodegenConfig

apiTestTemplateFiles

public Map<String,String> apiTestTemplateFiles()

Specified by:

apiTestTemplateFiles in interface CodegenConfig

modelTestTemplateFiles

public Map<String,String> modelTestTemplateFiles()

Specified by:

modelTestTemplateFiles in interface CodegenConfig

apiTemplateFiles

public Map<String,String> apiTemplateFiles()

Specified by:

apiTemplateFiles in interface CodegenConfig

modelTemplateFiles

public Map<String,String> modelTemplateFiles()

Specified by:

modelTemplateFiles in interface CodegenConfig

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface CodegenConfig

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

modelTestFileFolder in interface CodegenConfig

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface CodegenConfig

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface CodegenConfig

additionalProperties

public Map<String,Object> additionalProperties()

Specified by:

additionalProperties in interface CodegenConfig

vendorExtensions

public Map<String,Object> vendorExtensions()

Specified by:

vendorExtensions in interface CodegenConfig

supportingFiles

public List<SupportingFile> supportingFiles()

Specified by:

supportingFiles in interface CodegenConfig

outputFolder

public String outputFolder()

Specified by:

outputFolder in interface CodegenConfig

setOutputDir

public void setOutputDir(String dir)

Specified by:

setOutputDir in interface CodegenConfig

getOutputDir

public String getOutputDir()

Specified by:

getOutputDir in interface CodegenConfig

getInputSpec

public String getInputSpec()

Specified by:

getInputSpec in interface CodegenConfig

setInputSpec

public void setInputSpec(String inputSpec)

Specified by:

setInputSpec in interface CodegenConfig

setTemplateDir

public void setTemplateDir(String templateDir)

setModelPackage

public void setModelPackage(String modelPackage)

getModelNamePrefix

public String getModelNamePrefix()

setModelNamePrefix

public void setModelNamePrefix(String modelNamePrefix)

getModelNameSuffix

public String getModelNameSuffix()

setModelNameSuffix

public void setModelNameSuffix(String modelNameSuffix)

setApiPackage

public void setApiPackage(String apiPackage)

getSortParamsByRequiredFlag

public Boolean getSortParamsByRequiredFlag()

setSortParamsByRequiredFlag

public void setSortParamsByRequiredFlag(Boolean sortParamsByRequiredFlag)

getPrependFormOrBodyParameters

public Boolean getPrependFormOrBodyParameters()

setPrependFormOrBodyParameters

public void setPrependFormOrBodyParameters(Boolean prependFormOrBodyParameters)

getEnsureUniqueParams

public Boolean getEnsureUniqueParams()

setEnsureUniqueParams

public void setEnsureUniqueParams(Boolean ensureUniqueParams)

getAllowUnicodeIdentifiers

public Boolean getAllowUnicodeIdentifiers()

setAllowUnicodeIdentifiers

public void setAllowUnicodeIdentifiers(Boolean allowUnicodeIdentifiers)

toRegularExpression

public String toRegularExpression(String pattern)

Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)

Parameters:

pattern - the pattern (regular expression)

Returns:

properly-escaped pattern

toApiFilename

public String toApiFilename(String name)

Return the file name of the Api Test

Specified by:

toApiFilename in interface CodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiDocFilename

public String toApiDocFilename(String name)

Return the file name of the Api Documentation

Specified by:

toApiDocFilename in interface CodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiTestFilename

public String toApiTestFilename(String name)

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface CodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiVarName

public String toApiVarName(String name)

Return the variable name in the Api

Specified by:

toApiVarName in interface CodegenConfig

Parameters:

name - the varible name of the Api

Returns:

the snake-cased variable name

toModelFilename

public String toModelFilename(String name)

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toModelTestFilename

public String toModelTestFilename(String name)

Return the capitalized file name of the model test

Specified by:

toModelTestFilename in interface CodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toModelDocFilename

public String toModelDocFilename(String name)

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface CodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

getGeneratorMetadata

public GeneratorMetadata getGeneratorMetadata()

Returns metadata about the generator.

Specified by:

getGeneratorMetadata in interface CodegenConfig

Returns:

A provided GeneratorMetadata instance

toOperationId

public String toOperationId(String operationId)

Return the operation ID (method name)

Parameters:

operationId - operation ID

Returns:

the sanitized method name

toVarName

public String toVarName(String name)

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

Specified by:

toParamName in interface CodegenConfig

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toArrayModelParamName

public String toArrayModelParamName(String name)

Return the parameter name of array of model

Parameters:

name - name of the array model

Returns:

the sanitized parameter name

toEnumName

public String toEnumName(CodegenProperty property)

Return the Enum name (e.g. StatusEnum given 'status')

Parameters:

property - Codegen property

Returns:

the Enum name

escapeReservedWord

public String escapeReservedWord(String name)

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word

throws Runtime exception as reserved word is not allowed (default behavior)

toModelImport

public String toModelImport(String name)

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface CodegenConfig

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

toApiImport

public String toApiImport(String name)

Return the fully-qualified "Api" name for import

Specified by:

toApiImport in interface CodegenConfig

Parameters:

name - the name of the "Api"

Returns:

the fully-qualified "Api" name for import

initalizeSpecialCharacterMapping

protected void initalizeSpecialCharacterMapping()

Initialize special character mapping

getSymbolName

protected String getSymbolName(String input)

Return the symbol name of a symbol

Parameters:

input - Symbol (e.g. $)

Returns:

Symbol name (e.g. Dollar)

generateExamplePath

public String generateExamplePath(String path,
                                  io.swagger.v3.oas.models.Operation operation)

Return the example path

Specified by:

generateExamplePath in interface CodegenConfig

Parameters:

path - the path of the operation

operation - OAS operation object

Returns:

string presentation of the example path

toInstantiationType

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

Return the instantiation type of the property, especially for map and array

Parameters:

schema - property schema

Returns:

string presentation of the instantiation type of the property

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter codegenParameter)

Return the example value of the parameter.

Parameters:

codegenParameter - Codegen parameter

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.Parameter parameter)

Return the example value of the parameter.

Parameters:

codegenParameter - Codegen parameter

parameter - Parameter

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.RequestBody requestBody)

Return the example value of the parameter.

Parameters:

codegenParameter - Codegen parameter

requestBody - Request body

toExampleValue

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

Return the example value of the property

Parameters:

schema - Property schema

Returns:

string presentation of the example value of the property

toDefaultValue

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

Return the default value of the property

Parameters:

schema - Property schema

Returns:

string presentation of the default value of the property

toDefaultValueWithParam

public String toDefaultValueWithParam(String name,
                                      io.swagger.v3.oas.models.media.Schema schema)

Return the property initialized from a data object Useful for initialization with a plain object in Javascript

Parameters:

name - Name of the property object

schema - Property schema

Returns:

string presentation of the default value of the property

getSchemaType

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

returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type

Parameters:

schema - property schema

Returns:

string presentation of the type

toAllOfName

public String toAllOfName(List<String> names,
                          io.swagger.v3.oas.models.media.ComposedSchema composedSchema)

Return the name of the allOf schema

Parameters:

names - List of names

composedSchema - composed schema

Returns:

name of the allOf schema

toAnyOfName

public String toAnyOfName(List<String> names,
                          io.swagger.v3.oas.models.media.ComposedSchema composedSchema)

Return the name of the anyOf schema

Parameters:

names - List of names

composedSchema - composed schema

Returns:

name of the anyOf schema

toOneOfName

public String toOneOfName(List<String> names,
                          io.swagger.v3.oas.models.media.ComposedSchema composedSchema)

Return the name of the oneOf schema

Parameters:

names - List of names

composedSchema - composed schema

Returns:

name of the oneOf schema

snakeCase

public String snakeCase(String name)

Return the snake-case of the string

Parameters:

name - string to be snake-cased

Returns:

snake-cased string

getTypeDeclaration

public String getTypeDeclaration(String name)

Output the type declaration of a given name

Specified by:

getTypeDeclaration in interface CodegenConfig

Parameters:

name - name

Returns:

a string presentation of the type

getTypeDeclaration

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

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface CodegenConfig

Parameters:

schema - property schema

Returns:

a string presentation of the property type

getAlias

public String getAlias(String name)

Determine the type alias for the given type if it exists. This feature was originally developed for Java because the language does not have an aliasing mechanism of its own but later extends to handle other languages

Parameters:

name - The type name.

Returns:

The alias of the given type, if it exists. If there is no alias for this type, then returns the input type name.

toBooleanGetter

public String toBooleanGetter(String name)

Output the Getter name for boolean property, e.g. getActive

Specified by:

toBooleanGetter in interface CodegenConfig

Parameters:

name - the name of the property

Returns:

getter name based on naming convention

toGetter

public String toGetter(String name)

Output the Getter name, e.g. getSize

Specified by:

toGetter in interface CodegenConfig

Parameters:

name - the name of the property

Returns:

getter name based on naming convention

toSetter

public String toSetter(String name)

Output the Setter name, e.g. setSize

Specified by:

toSetter in interface CodegenConfig

Parameters:

name - the name of the property

Returns:

setter name based on naming convention

toApiName

public String toApiName(String name)

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toModelName

public String toModelName(String name)

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface CodegenConfig

Parameters:

name - the name of the model

Returns:

capitalized model name

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema schema)

Convert OAS Model object to Codegen Model object

Specified by:

fromModel in interface CodegenConfig

Parameters:

name - the name of the model

schema - OAS Model object

Returns:

Codegen Model object

addAdditionPropertiesToCodeGenModel

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

addProperties

protected void addProperties(Map<String,io.swagger.v3.oas.models.media.Schema> properties,
                             List<String> required,
                             io.swagger.v3.oas.models.media.Schema schema)

Add schema's properties to "properties" and "required" list

Parameters:

properties - all properties

required - required property only

schema - schema in which the properties will be added to the lists

getterAndSetterCapitalize

public String getterAndSetterCapitalize(String name)

Camelize the method name of the getter and setter

Parameters:

name - string to be camelized

Returns:

Camelized string

fromProperty

public CodegenProperty fromProperty(String name,
                                    io.swagger.v3.oas.models.media.Schema p)

Convert OAS Property object to Codegen Property object

Parameters:

name - name of the property

p - OAS property object

Returns:

Codegen Property object

updatePropertyForArray

protected void updatePropertyForArray(CodegenProperty property,
                                      CodegenProperty innerProperty)

Update property for array(list) container

Parameters:

property - Codegen property

innerProperty - Codegen inner property of map or list

updatePropertyForMap

protected void updatePropertyForMap(CodegenProperty property,
                                    CodegenProperty innerProperty)

Update property for map container

Parameters:

property - Codegen property

innerProperty - Codegen inner property of map or list

isPropertyInnerMostEnum

protected Boolean isPropertyInnerMostEnum(CodegenProperty property)

Update property for map container

Parameters:

property - Codegen property

Returns:

True if the inner most type is enum

getMostInnerItems

protected CodegenProperty getMostInnerItems(CodegenProperty property)

getInnerEnumAllowableValues

protected Map<String,Object> getInnerEnumAllowableValues(CodegenProperty property)

updateDataTypeWithEnumForArray

protected void updateDataTypeWithEnumForArray(CodegenProperty property)

Update datatypeWithEnum for array container

Parameters:

property - Codegen property

updateDataTypeWithEnumForMap

protected void updateDataTypeWithEnumForMap(CodegenProperty property)

Update datatypeWithEnum for map container

Parameters:

property - Codegen property

setNonArrayMapProperty

protected void setNonArrayMapProperty(CodegenProperty property,
                                      String type)

findMethodResponse

protected io.swagger.v3.oas.models.responses.ApiResponse findMethodResponse(io.swagger.v3.oas.models.responses.ApiResponses responses)

Override with any special handling of response codes

Parameters:

responses - OAS Operation's responses

Returns:

default method response or null if not found

fromOperation

public CodegenOperation 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

Specified by:

fromOperation in interface CodegenConfig

Parameters:

httpMethod - HTTP method

operation - OAS operation object

path - the path of the operation

servers - list of servers

Returns:

Codegen Operation object

isParameterNameUnique

public boolean isParameterNameUnique(CodegenParameter p,
                                     List<CodegenParameter> parameters)

fromResponse

public CodegenResponse fromResponse(String responseCode,
                                    io.swagger.v3.oas.models.responses.ApiResponse response)

Convert OAS Response object to Codegen Response object

Parameters:

responseCode - HTTP response code

response - OAS Response object

Returns:

Codegen Response object

fromCallback

public CodegenCallback fromCallback(String name,
                                    io.swagger.v3.oas.models.callbacks.Callback callback,
                                    List<io.swagger.v3.oas.models.servers.Server> servers)

Convert OAS Callback object to Codegen Callback object

Parameters:

name - callback name

callback - OAS Callback object

servers - list of servers

Returns:

Codegen Response object

fromParameter

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

Convert OAS Parameter object to Codegen Parameter object

Parameters:

parameter - OAS parameter object

imports - set of imports for library/package/module

Returns:

Codegen Parameter object

getParameterDataType

protected String getParameterDataType(io.swagger.v3.oas.models.parameters.Parameter parameter,
                                      io.swagger.v3.oas.models.media.Schema schema)

Returns the data type of a parameter. Returns null by default to use the CodegenProperty.datatype value

Parameters:

parameter - Parameter

schema - Schema

Returns:

data type

isDataTypeBinary

public boolean isDataTypeBinary(String dataType)

isDataTypeFile

public boolean isDataTypeFile(String dataType)

fromSecurity

public List<CodegenSecurity> fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> securitySchemeMap)

Convert map of OAS SecurityScheme objects to a list of Codegen Security objects

Specified by:

fromSecurity in interface CodegenConfig

Parameters:

securitySchemeMap - a map of OAS SecuritySchemeDefinition object

Returns:

a list of Codegen Security objects

setReservedWordsLowerCase

protected void setReservedWordsLowerCase(List<String> words)

isReservedWord

protected boolean isReservedWord(String word)

getOrGenerateOperationId

protected String getOrGenerateOperationId(io.swagger.v3.oas.models.Operation operation,
                                          String path,
                                          String httpMethod)

Get operationId from the operation object, and if it's blank, generate a new one from the given parameters.

Parameters:

operation - the operation object

path - the path of the operation

httpMethod - the HTTP method of the operation

Returns:

the (generated) operationId

needToImport

protected boolean needToImport(String type)

Check the type to see if it needs import the library/module/package

Parameters:

type - name of the type

Returns:

true if the library/module/package of the corresponding type needs to be imported

toExamples

protected List<Map<String,Object>> toExamples(Map<String,Object> examples)

addOperationToGroup

public void addOperationToGroup(String tag,
                                String resourcePath,
                                io.swagger.v3.oas.models.Operation operation,
                                CodegenOperation co,
                                Map<String,List<CodegenOperation>> operations)

Add operation to group

Specified by:

addOperationToGroup in interface CodegenConfig

Parameters:

tag - name of the tag

resourcePath - path of the resource

operation - OAS Operation object

co - Codegen Operation object

operations - map of Codegen operations

addImport

protected void addImport(CodegenModel m,
                         String type)

removeNonNameElementToCamelCase

public String removeNonNameElementToCamelCase(String name)

Remove characters not suitable for variable or method name from the input and camelize it

Parameters:

name - string to be camelize

Returns:

camelized string

removeNonNameElementToCamelCase

protected String removeNonNameElementToCamelCase(String name,
                                                 String nonNameElementPattern)

Remove characters that is not good to be included in method name from the input and camelize it

Parameters:

name - string to be camelize

nonNameElementPattern - a regex pattern of the characters that is not good to be included in name

Returns:

camelized string

apiFilename

public String apiFilename(String templateName,
                          String tag)

Specified by:

apiFilename in interface CodegenConfig

apiDocFilename

public String apiDocFilename(String templateName,
                             String tag)

Return the full path and API documentation file

Specified by:

apiDocFilename in interface CodegenConfig

Parameters:

templateName - template name

tag - tag

Returns:

the API documentation file name with full path

apiTestFilename

public String apiTestFilename(String templateName,
                              String tag)

Return the full path and API test file

Specified by:

apiTestFilename in interface CodegenConfig

Parameters:

templateName - template name

tag - tag

Returns:

the API test file name with full path

shouldOverwrite

public boolean shouldOverwrite(String filename)

Specified by:

shouldOverwrite in interface CodegenConfig

isSkipOverwrite

public boolean isSkipOverwrite()

Specified by:

isSkipOverwrite in interface CodegenConfig

setSkipOverwrite

public void setSkipOverwrite(boolean skipOverwrite)

Specified by:

setSkipOverwrite in interface CodegenConfig

isRemoveOperationIdPrefix

public boolean isRemoveOperationIdPrefix()

Specified by:

isRemoveOperationIdPrefix in interface CodegenConfig

setRemoveOperationIdPrefix

public void setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)

Specified by:

setRemoveOperationIdPrefix in interface CodegenConfig

isHideGenerationTimestamp

public boolean isHideGenerationTimestamp()

Specified by:

isHideGenerationTimestamp in interface CodegenConfig

setHideGenerationTimestamp

public void setHideGenerationTimestamp(boolean hideGenerationTimestamp)

Specified by:

setHideGenerationTimestamp in interface CodegenConfig

supportedLibraries

public Map<String,String> supportedLibraries()

All library templates supported. (key: library name, value: library description)

Specified by:

supportedLibraries in interface CodegenConfig

Returns:

the supported libraries

setLibrary

public void setLibrary(String library)

Set library template (sub-template).

Specified by:

setLibrary in interface CodegenConfig

Parameters:

library - Library template

getLibrary

public String getLibrary()

Library template (sub-template).

Specified by:

getLibrary in interface CodegenConfig

Returns:

Library template

setGitUserId

public void setGitUserId(String gitUserId)

Set Git user ID.

Specified by:

setGitUserId in interface CodegenConfig

Parameters:

gitUserId - Git user ID

getGitUserId

public String getGitUserId()

Git user ID

Specified by:

getGitUserId in interface CodegenConfig

Returns:

Git user ID

setGitRepoId

public void setGitRepoId(String gitRepoId)

Set Git repo ID.

Specified by:

setGitRepoId in interface CodegenConfig

Parameters:

gitRepoId - Git repo ID

getGitRepoId

public String getGitRepoId()

Git repo ID

Specified by:

getGitRepoId in interface CodegenConfig

Returns:

Git repo ID

setReleaseNote

public void setReleaseNote(String releaseNote)

Set release note.

Specified by:

setReleaseNote in interface CodegenConfig

Parameters:

releaseNote - Release note

getReleaseNote

public String getReleaseNote()

Release note

Specified by:

getReleaseNote in interface CodegenConfig

Returns:

Release note

getDocExtension

public String getDocExtension()

Documentation files extension

Specified by:

getDocExtension in interface CodegenConfig

Returns:

Documentation files extension

setDocExtension

public void setDocExtension(String userDocExtension)

Set Documentation files extension

Specified by:

setDocExtension in interface CodegenConfig

Parameters:

userDocExtension - documentation files extension

setHttpUserAgent

public void setHttpUserAgent(String httpUserAgent)

Set HTTP user agent.

Specified by:

setHttpUserAgent in interface CodegenConfig

Parameters:

httpUserAgent - HTTP user agent

getHttpUserAgent

public String getHttpUserAgent()

HTTP user agent

Specified by:

getHttpUserAgent in interface CodegenConfig

Returns:

HTTP user agent

buildLibraryCliOption

protected CliOption buildLibraryCliOption(Map<String,String> supportedLibraries)

sanitizeName

public String sanitizeName(String name)

Sanitize name (parameter, property, method, etc)

Specified by:

sanitizeName in interface CodegenConfig

Parameters:

name - string to be sanitize

Returns:

sanitized string

setTemplatingEngine

public void setTemplatingEngine(TemplatingEngineAdapter templatingEngine)

Specified by:

setTemplatingEngine in interface CodegenConfig

getTemplatingEngine

public TemplatingEngineAdapter getTemplatingEngine()

Specified by:

getTemplatingEngine in interface CodegenConfig

sanitizeName

public String sanitizeName(String name,
                           String removeCharRegEx)

Sanitize name (parameter, property, method, etc)

Parameters:

name - string to be sanitize

removeCharRegEx - a regex containing all char that will be removed

Returns:

sanitized string

sanitizeTag

public String sanitizeTag(String tag)

Sanitize tag

Specified by:

sanitizeTag in interface CodegenConfig

Parameters:

tag - Tag

Returns:

Sanitized tag

writeOptional

public void writeOptional(String outputFolder,
                          SupportingFile supportingFile)

Only write if the file doesn't exist

Parameters:

outputFolder - Output folder

supportingFile - Supporting file

setParameterBooleanFlagWithCodegenProperty

public void setParameterBooleanFlagWithCodegenProperty(CodegenParameter parameter,
                                                       CodegenProperty property)

Set CodegenParameter boolean flag using CodegenProperty.

Parameters:

parameter - Codegen Parameter

property - Codegen property

updateCodegenPropertyEnum

public void updateCodegenPropertyEnum(CodegenProperty var)

Update codegen property's enum by adding "enumVars" (with name and value)

Parameters:

var - list of CodegenProperty

addRegularExpressionDelimiter

public String addRegularExpressionDelimiter(String pattern)

If the pattern misses the delimiter, add "/" to the beginning and end Otherwise, return the original pattern

Parameters:

pattern - the pattern (regular expression)

Returns:

the pattern with delimiter

convertPropertyToBooleanAndWriteBack

public boolean convertPropertyToBooleanAndWriteBack(String propertyKey)

reads propertyKey from additionalProperties, converts it to a boolean and writes it back to additionalProperties to be usable as a boolean in mustache files.

Parameters:

propertyKey - property key

Returns:

property value as boolean

getIgnoreFilePathOverride

public String getIgnoreFilePathOverride()

Provides an override location, if any is specified, for the .openapi-generator-ignore.

This is originally intended for the first generation only.

Specified by:

getIgnoreFilePathOverride in interface CodegenConfig

Returns:

a string of the full path to an override ignore file.

setIgnoreFilePathOverride

public void setIgnoreFilePathOverride(String ignoreFileOverride)

Sets an override location for the '.openapi-generator-ignore' location for the first code generation.

Specified by:

setIgnoreFilePathOverride in interface CodegenConfig

Parameters:

ignoreFileOverride - The full path to an ignore file

convertPropertyToBoolean

public boolean convertPropertyToBoolean(String propertyKey)

writePropertyBack

public void writePropertyBack(String propertyKey,
                              boolean value)

getContentType

protected String getContentType(io.swagger.v3.oas.models.parameters.RequestBody requestBody)

getConsumesInfo

public static Set<String> getConsumesInfo(io.swagger.v3.oas.models.OpenAPI openAPI,
                                          io.swagger.v3.oas.models.Operation operation)

hasFormParameter

public boolean hasFormParameter(io.swagger.v3.oas.models.OpenAPI openAPI,
                                io.swagger.v3.oas.models.Operation operation)

hasBodyParameter

public boolean hasBodyParameter(io.swagger.v3.oas.models.OpenAPI openAPI,
                                io.swagger.v3.oas.models.Operation operation)

getProducesInfo

public static Set<String> getProducesInfo(io.swagger.v3.oas.models.OpenAPI openAPI,
                                          io.swagger.v3.oas.models.Operation operation)

returns the list of MIME types the APIs can produce

Parameters:

openAPI - current specification instance

operation - Operation

Returns:

a set of MIME types

getCollectionFormat

protected String getCollectionFormat(io.swagger.v3.oas.models.parameters.Parameter parameter)

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

getName

public String getName()

Specified by:

getName in interface CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

fromRequestBodyToFormParameters

public List<CodegenParameter> fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body,
                                                              Set<String> imports)

fromFormProperty

public CodegenParameter fromFormProperty(String name,
                                         io.swagger.v3.oas.models.media.Schema propertySchema,
                                         Set<String> imports)

fromRequestBody

public CodegenParameter fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body,
                                        Set<String> imports,
                                        String bodyParameterName)

addOption

protected void addOption(String key,
                         String description,
                         String defaultValue)

updateOption

protected void updateOption(String key,
                            String defaultValue)

addSwitch

protected void addSwitch(String key,
                         String description,
                         Boolean defaultValue)

generateJSONSpecFile

public void generateJSONSpecFile(Map<String,Object> objs)

generates OpenAPI specification file in JSON format

Parameters:

objs - map of object

generateYAMLSpecFile

public void generateYAMLSpecFile(Map<String,Object> objs)

generates OpenAPI specification file in YAML format

Parameters:

objs - map of object

isDataTypeString

public boolean isDataTypeString(String dataType)

checks if the data should be classified as "string" in enum e.g. double in C# needs to be double-quoted (e.g. "2.8") by treating it as a string In the future, we may rename this function to "isEnumString"

Parameters:

dataType - data type

Returns:

true if it's a enum string

fromServers

public List<CodegenServer> fromServers(List<io.swagger.v3.oas.models.servers.Server> servers)

Specified by:

fromServers in interface CodegenConfig

fromServerVariables

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

Specified by:

fromServerVariables in interface CodegenConfig

postProcessFile

public void postProcessFile(File file,
                            String fileType)

Post-process the auto-generated file, e.g. using go-fmt to format the Go code. The file type can be "model-test", "model-doc", "model", "api", "api-test", "api-doc", "supporting-mustache", "supporting-common", "openapi-generator-ignore", "openapi-generator-version"

TODO: store these values in enum instead

Specified by:

postProcessFile in interface CodegenConfig

Parameters:

file - file to be processed

fileType - file type

isEnablePostProcessFile

public boolean isEnablePostProcessFile()

Boolean value indicating the state of the option for post-processing file using envirionment variables.

Specified by:

isEnablePostProcessFile in interface CodegenConfig

Returns:

true if the option is enabled

setEnablePostProcessFile

public void setEnablePostProcessFile(boolean enablePostProcessFile)

Set the boolean value indicating the state of the option for post-processing file using envirionment variables.

Specified by:

setEnablePostProcessFile in interface CodegenConfig

Parameters:

enablePostProcessFile - true to enable post-processing file

isEnableMinimalUpdate

public boolean isEnableMinimalUpdate()

Get the boolean value indicating the state of the option for updating only changed files

Specified by:

isEnableMinimalUpdate in interface CodegenConfig

setEnableMinimalUpdate

public void setEnableMinimalUpdate(boolean enableMinimalUpdate)

Set the boolean value indicating the state of the option for updating only changed files

Specified by:

setEnableMinimalUpdate in interface CodegenConfig

Parameters:

enableMinimalUpdate - true to enable minimal update

isStrictSpecBehavior

public boolean isStrictSpecBehavior()

Indicates whether the codegen configuration should treat documents as strictly defined by the OpenAPI specification.

Specified by:

isStrictSpecBehavior in interface CodegenConfig

Returns:

true to act strictly upon spec documents, potentially modifying the spec to strictly fit the spec.

setStrictSpecBehavior

public void setStrictSpecBehavior(boolean strictSpecBehavior)

Sets the boolean valid indicating whether generation will work strictly against the specification, potentially making minor changes to the input document.

Specified by:

setStrictSpecBehavior in interface CodegenConfig

Parameters:

strictSpecBehavior - true if we will behave strictly, false to allow specification documents which pass validation to be loosely interpreted against the spec.