Package io.swagger.codegen.v3.generators
Class DefaultCodegenConfig
java.lang.Object
io.swagger.codegen.v3.generators.DefaultCodegenConfig
- All Implemented Interfaces:
io.swagger.codegen.v3.CodegenConfig
- Direct Known Subclasses:
AbstractCSharpCodegen,AbstractGoCodegen,AbstractJavaCodegen,AbstractKotlinCodegen,AbstractPhpCodegen,AbstractScalaCodegen,AbstractSwiftCodegen,AbstractTypeScriptClientCodegen,DartClientCodegen,JavaScriptClientCodegen,NodeJSServerCodegen,OpenAPIGenerator,PhpClientCodegen,PythonClientCodegen,PythonFlaskConnexionCodegen,RClientCodegen,RubyClientCodegen,StaticDocCodegen,StaticHtml2Codegen,StaticHtmlCodegen,Swift5Codegen
public abstract class DefaultCodegenConfig
extends Object
implements io.swagger.codegen.v3.CodegenConfig
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Booleanprotected Stringprotected List<io.swagger.codegen.v3.CliOption>protected Stringprotected List<io.swagger.codegen.v3.SupportingFile>protected Stringstatic final Stringstatic final Stringprotected Stringprotected Booleanprotected Stringprotected Stringprotected Stringprotected Stringprotected Booleanprotected Stringprotected Stringprotected booleanprotected Stringprotected Stringstatic final Stringstatic final Stringprotected List<io.swagger.codegen.v3.CodegenArgument>protected Stringprotected static final org.slf4j.Loggerprotected Stringprotected Stringprotected Stringprotected io.swagger.v3.oas.models.OpenAPIprotected Stringprotected Stringprotected booleanstatic final Stringprotected booleanprotected Booleanprotected List<io.swagger.codegen.v3.SupportingFile>protected booleanprotected booleanprotected Stringprotected io.swagger.codegen.v3.templates.TemplateEngineprotected Stringprotected Stringprotected io.swagger.v3.oas.models.OpenAPIprotected boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema) protected voidaddCodegenContentParameters(io.swagger.codegen.v3.CodegenOperation codegenOperation, List<io.swagger.codegen.v3.CodegenContent> codegenContents) protected voidaddConsumesInfo(io.swagger.v3.oas.models.Operation operation, io.swagger.codegen.v3.CodegenOperation codegenOperation, io.swagger.v3.oas.models.OpenAPI openAPI) voidaddHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars) protected voidprotected voidaddOperationImports(io.swagger.codegen.v3.CodegenOperation codegenOperation, Set<String> operationImports) voidaddOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, io.swagger.codegen.v3.CodegenOperation co, Map<String, List<io.swagger.codegen.v3.CodegenOperation>> operations) Add operation to groupprotected voidprotected voidprotected voidaddParameters(io.swagger.codegen.v3.CodegenContent codegenContent, List<io.swagger.codegen.v3.CodegenParameter> codegenParameters) voidaddParentContainer(io.swagger.codegen.v3.CodegenModel codegenModel, String name, io.swagger.v3.oas.models.media.Schema schema) protected voidaddProducesInfo(io.swagger.v3.oas.models.responses.ApiResponse response, io.swagger.codegen.v3.CodegenOperation codegenOperation) protected voidaddProperties(Map<String, io.swagger.v3.oas.models.media.Schema> properties, List<String> required, io.swagger.v3.oas.models.media.Schema schema, Map<String, io.swagger.v3.oas.models.media.Schema> allSchemas) addRegularExpressionDelimiter(String pattern) If the pattern misses the delimiter, add "/" to the beginning and end Otherwise, return the original patternprotected voidprotected voidaddVars(io.swagger.codegen.v3.CodegenModel codegenModel, Map<String, io.swagger.v3.oas.models.media.Schema> properties, List<String> required) apiDocFilename(String templateName, String tag) Return the full path and API documentation fileapiFilename(String templateName, String tag) apiTestFilename(String templateName, String tag) Return the full path and API test fileprotected io.swagger.codegen.v3.CliOptionbuildLibraryCliOption(Map<String, String> supportedLibraries) static StringCamelize name (parameter, property, method, etc) with upper case for first letter copied from Twitter elephant bird https://github.com/twitter/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/util/Strings.javastatic StringCamelize name (parameter, property, method, etc)List<io.swagger.codegen.v3.CliOption>List<io.swagger.codegen.v3.SupportingFile>protected voidconfigureDataForTestTemplate(io.swagger.codegen.v3.CodegenOperation codegenOperation) protected voidconfiguresParameterForMediaType(io.swagger.codegen.v3.CodegenOperation codegenOperation, List<io.swagger.codegen.v3.CodegenContent> codegenContents) booleanconvertPropertyToBoolean(String propertyKey) booleanconvertPropertyToBooleanAndWriteBack(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.protected booleancopyFirstAllOfProperties(io.swagger.v3.oas.models.media.Schema allOfSchema) protected StringDashize the given word.booleanprotected io.swagger.v3.oas.models.media.SchemadetectParent(io.swagger.v3.oas.models.media.ComposedSchema composedSchema, Map<String, io.swagger.v3.oas.models.media.Schema> allSchemas) protected voidensureUniqueParameters(List<io.swagger.codegen.v3.CodegenParameter> codegenParameters) escapeQuotationMark(String input) Escape single and/or double quote to avoid code injectionescapeReservedWord(String name) Return the escaped name of the reserved wordescapeText(String input) escapeUnsafeCharacters(String input) override with any special text escaping logic to handle unsafe characters so as to avoid code injectionfindCommonPrefixOfVars(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.ApiResponsefindMethodResponse(io.swagger.v3.oas.models.responses.ApiResponses responses) Override with any special handling of response codesprotected voidfixUpParentAndInterfaces(io.swagger.codegen.v3.CodegenModel codegenModel, Map<String, io.swagger.codegen.v3.CodegenModel> allModels) Fix up all parent and interface CodegenModel references.io.swagger.codegen.v3.CodegenModelConvert Swagger Model object to Codegen Model object without providing all model definitionsio.swagger.codegen.v3.CodegenModelfromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String, io.swagger.v3.oas.models.media.Schema> allDefinitions) Convert Swagger Model object to Codegen Model objectio.swagger.codegen.v3.CodegenOperationfromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String, io.swagger.v3.oas.models.media.Schema> schemas) Convert Swagger Operation object to Codegen Operation object (without providing a Swagger object)io.swagger.codegen.v3.CodegenOperationfromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String, io.swagger.v3.oas.models.media.Schema> schemas, io.swagger.v3.oas.models.OpenAPI openAPI) Convert Swagger Operation object to Codegen Operation objectio.swagger.codegen.v3.CodegenParameterfromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter, Set<String> imports) Convert Swagger Parameter object to Codegen Parameter objectio.swagger.codegen.v3.CodegenPropertyfromProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema) Convert Swagger Property object to Codegen Property objectio.swagger.codegen.v3.CodegenParameterfromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, String name, io.swagger.v3.oas.models.media.Schema schema, Map<String, io.swagger.v3.oas.models.media.Schema> schemas, Set<String> imports) io.swagger.codegen.v3.CodegenResponsefromResponse(String responseCode, io.swagger.v3.oas.models.responses.ApiResponse response) Convert Swagger Response object to Codegen Response objectList<io.swagger.codegen.v3.CodegenSecurity>fromSecurity(Map<String, io.swagger.v3.oas.models.security.SecurityScheme> securitySchemeMap) Convert map of Swagger SecurityScheme objects to a list of Codegen Security objectsgenerateExamplePath(String path, io.swagger.v3.oas.models.Operation operation) Return the example pathDetermine the type alias for the given type if it exists.protected StringgetCollectionFormat(io.swagger.v3.oas.models.parameters.Parameter parameter) getConsumesInfo(io.swagger.v3.oas.models.Operation operation) protected StringgetContentType(io.swagger.v3.oas.models.parameters.RequestBody requestBody) abstract StringGit repo Base URLGit repo IDGit user IDHide generation timestampHTTP user agentProvides an override location, if any is specified, for the .swagger-codegen-ignore.booleangetInnerEnumAllowableValues(io.swagger.codegen.v3.CodegenProperty property) List<io.swagger.codegen.v3.CodegenArgument>Library template (sub-template).io.swagger.v3.oas.models.OpenAPIprotected StringgetOptionValue(String optionName) protected StringgetOrGenerateOperationId(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.protected io.swagger.v3.oas.models.parameters.ParametergetParameterFromRef(String ref, io.swagger.v3.oas.models.OpenAPI openAPI) protected StringgetParentName(io.swagger.v3.oas.models.media.ComposedSchema composedSchema) getProducesInfo(io.swagger.v3.oas.models.Operation operation) Release noteprotected io.swagger.v3.oas.models.media.SchemagetSchemaFromBody(io.swagger.v3.oas.models.parameters.RequestBody requestBody) protected io.swagger.v3.oas.models.media.SchemagetSchemaFromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter) protected io.swagger.v3.oas.models.media.SchemagetSchemaFromResponse(io.swagger.v3.oas.models.responses.ApiResponse response) io.swagger.codegen.v3.ISchemaHandlergetSchemaType(io.swagger.v3.oas.models.media.Schema property) returns the swagger type for the propertyprotected StringgetSymbolName(String input) Return the symbol name of a symbolprotected Stringio.swagger.codegen.v3.templates.TemplateEngineCamelize the method name of the getter and settergetTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema) Output the type declaration of the propertygetTypeDeclaration(String name) Output the type declaration of a given nameprotected static booleanhasSchemaProperties(io.swagger.v3.oas.models.media.Schema schema) protected static booleanhasTrueAdditionalProperties(io.swagger.v3.oas.models.media.Schema schema) initialCaps(String name) Capitalize the stringbooleanisDataTypeBinary(String dataType) booleanisDataTypeFile(String dataType) protected booleanisFileTypeSchema(io.swagger.v3.oas.models.media.Schema schema) booleanisObjectSchema(io.swagger.v3.oas.models.media.Schema schema) booleanisPrimivite(String datatype) protected BooleanisPropertyInnerMostEnum(io.swagger.codegen.v3.CodegenProperty property) Update property for map containerbooleanprotected booleanisReservedWord(String word) booleanbooleanprotected booleanneedToImport(String type) Check the type to see if it needs import the library/module/packageprotected voidpostProcessAllCodegenModels(Map<String, io.swagger.codegen.v3.CodegenModel> allModels) postProcessAllModels(Map<String, Object> processedModels) voidpostProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property) postProcessModels(Map<String, Object> objs) postProcessModelsEnum(Map<String, Object> objs) post process enum defined in model's propertiespostProcessOperations(Map<String, Object> objs) voidpostProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter) voidpreprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) com.samskivert.mustache.Mustache.CompilerprocessCompiler(com.samskivert.mustache.Mustache.Compiler compiler) protected voidprocessMapSchema(io.swagger.codegen.v3.CodegenModel codegenModel, String name, io.swagger.v3.oas.models.media.Schema schema) voidprocessModelEnums(Map<String, Object> objs) voidprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) voidprotected voidprocessPropertySchemaContainerTypes(io.swagger.codegen.v3.CodegenProperty codegenProperty, io.swagger.v3.oas.models.media.Schema propertySchema, String type) protected voidprocessPropertySchemaTypes(String name, io.swagger.codegen.v3.CodegenProperty codegenProperty, io.swagger.v3.oas.models.media.Schema propertySchema) List<io.swagger.codegen.v3.CodegenArgument>Remove characters not suitable for variable or method name from the input and camelize itprotected StringremoveNonNameElementToCamelCase(String name, String nonNameElementPattern) Remove characters that is not good to be included in method name from the input and camelize itsanitizeName(String name) Sanitize name (parameter, property, method, etc)sanitizeTag(String tag) Sanitize tagvoidsetAllowUnicodeIdentifiers(Boolean allowUnicodeIdentifiers) voidsetApiPackage(String apiPackage) voidsetCommonTemplateDir(String commonTemplateDir) voidsetEnsureUniqueParams(Boolean ensureUniqueParams) voidsetGitRepoBaseURL(String gitRepoBaseURL) Set Git repo Base URL.voidsetGitRepoId(String gitRepoId) Set Git repo ID.voidsetGitUserId(String gitUserId) Set Git user ID.voidsetHideGenerationTimestamp(Boolean hideGenerationTimestamp) Hide generation timestampvoidsetHttpUserAgent(String httpUserAgent) Set HTTP user agent.voidsetIgnoreFilePathOverride(String ignoreFileOverride) Sets an override location for the .swagger-codegen.ignore location for the first code generation.voidsetIgnoreImportMapping(boolean ignoreImportMapping) voidsetInputSpec(String inputSpec) voidsetInputURL(String inputURL) voidsetLanguageArguments(List<io.swagger.codegen.v3.CodegenArgument> languageArguments) voidsetLibrary(String library) Set library template (sub-template).voidsetModelNamePrefix(String modelNamePrefix) voidsetModelNameSuffix(String modelNameSuffix) voidsetModelPackage(String modelPackage) protected voidsetNonArrayMapProperty(io.swagger.codegen.v3.CodegenProperty property, String type) voidsetOutputDir(String dir) voidsetParameterBooleanFlagWithCodegenProperty(io.swagger.codegen.v3.CodegenParameter parameter, io.swagger.codegen.v3.CodegenProperty property) Set CodegenParameter boolean flag using CodegenProperty.voidsetParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p) Return the example value of the parameter.protected voidsetParameterJson(io.swagger.codegen.v3.CodegenParameter codegenParameter, io.swagger.v3.oas.models.media.Schema parameterSchema) protected voidsetParameterNullable(io.swagger.codegen.v3.CodegenParameter parameter, io.swagger.codegen.v3.CodegenProperty property) voidsetReleaseNote(String releaseNote) Set release note.voidsetRemoveOperationIdPrefix(boolean removeOperationIdPrefix) protected voidsetReservedWords(List<String> words) protected voidsetReservedWordsLowerCase(List<String> words) protected voidsetSchemaProperties(String name, io.swagger.codegen.v3.CodegenProperty codegenProperty, io.swagger.v3.oas.models.media.Schema schema) voidsetSkipOverwrite(boolean skipOverwrite) voidsetSortParamsByRequiredFlag(Boolean sortParamsByRequiredFlag) voidsetTemplateDir(String templateDir) protected voidvoidsetTemplateVersion(String templateVersion) voidsetUnflattenedOpenAPI(io.swagger.v3.oas.models.OpenAPI unflattenedOpenAPI) voidsetUseOas2(boolean useOas2) booleanshouldOverwrite(String filename) Return the snake-case of the stringAll library languages supported.List<io.swagger.codegen.v3.SupportingFile>toApiDocFilename(String name) Return the file name of the Api DocumentationtoApiFilename(String name) Return the file name of the Api TesttoApiImport(String name) Return the fully-qualified "Api" name for importOutput the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is emptytoApiTestFilename(String name) Return the file name of the Api TesttoApiVarName(String name) Return the variable name in the ApitoBooleanGetter(String name) Output the Getter name for boolean property, e.g.toDefaultValue(io.swagger.v3.oas.models.media.Schema property) Return the default value of the propertytoDefaultValueWithParam(String name, io.swagger.v3.oas.models.media.Schema property) Return the property initialized from a data object Useful for initialization with a plain object in JavascripttoEnumDefaultValue(String value, String datatype) Return the enum default value in the language specified formattoEnumName(io.swagger.codegen.v3.CodegenProperty property) Return the Enum name (e.g.toEnumValue(String value, String datatype) Return the enum value in the language specified format e.g.toEnumVarName(String value, String datatype) Return the sanitized variable name for enumtoExamples(Map<String, Object> examples) toExampleValue(io.swagger.v3.oas.models.media.Schema property) Return the example value of the propertyOutput the Getter name, e.g.toInstantiationType(io.swagger.v3.oas.models.media.Schema property) Return the instantiation type of the property, especially for map and arraytoModelDocFilename(String name) Return the capitalized file name of the model documentationtoModelFilename(String name) Return the capitalized file name of the modeltoModelImport(String name) Return the fully-qualified "Model" name for importtoModelName(String name) Output the proper model name (capitalized).toModelTestFilename(String name) Return the capitalized file name of the model testtoOperationId(String operationId) Return the operation ID (method name)toParamName(String name) Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.toRegularExpression(String pattern) Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)Output the Getter name, e.g.Return the variable name by removing invalid characters and proper escaping if it's a reserved word.static Stringunderscore(String word) Underscore the given word.protected voidupdateCodegenModelEnumVars(io.swagger.codegen.v3.CodegenModel codegenModel) update codegen property enum with proper naming convention and handling of numbers, special charactersvoidupdateCodegenPropertyEnum(io.swagger.codegen.v3.CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)protected voidupdateDataTypeWithEnumForArray(io.swagger.codegen.v3.CodegenProperty property) Update datatypeWithEnum for array containerprotected voidupdateDataTypeWithEnumForMap(io.swagger.codegen.v3.CodegenProperty property) Update datatypeWithEnum for map containerprotected voidupdatePropertyForArray(io.swagger.codegen.v3.CodegenProperty property, io.swagger.codegen.v3.CodegenProperty innerProperty) Update property for array(list) containerprotected voidupdatePropertyForMap(io.swagger.codegen.v3.CodegenProperty property, io.swagger.codegen.v3.CodegenProperty innerProperty) Update property for map containervoidwriteOptional(String outputFolder, io.swagger.codegen.v3.SupportingFile supportingFile) voidwriteOptional(String outputFolder, io.swagger.codegen.v3.SupportingFile supportingFile, boolean configFile) Only write if the file doesn't existvoidwritePropertyBack(String propertyKey, boolean value) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.swagger.codegen.v3.CodegenConfig
checkAliasModel, getCodeName, getHelp, getName, getPriority, getTag, isPrivileged
-
Field Details
-
LOGGER
protected static final org.slf4j.Logger LOGGER -
DEFAULT_CONTENT_TYPE
- See Also:
-
REQUEST_BODY_NAME
- See Also:
-
DEFAULT_TEMPLATE_DIR
- See Also:
-
IS_NULLABLE_FALSE
- See Also:
-
IS_NULLABLE_TRUE
- See Also:
-
openAPI
protected io.swagger.v3.oas.models.OpenAPI openAPI -
unflattenedOpenAPI
protected io.swagger.v3.oas.models.OpenAPI unflattenedOpenAPI -
inputSpec
-
inputURL
-
outputFolder
-
defaultIncludes
-
typeMapping
-
instantiationTypes
-
reservedWords
-
languageSpecificPrimitives
-
importMapping
-
modelPackage
-
apiPackage
-
fileSuffix
-
modelNamePrefix
-
modelNameSuffix
-
testPackage
-
apiTemplateFiles
-
modelTemplateFiles
-
apiTestTemplateFiles
-
modelTestTemplateFiles
-
apiDocTemplateFiles
-
modelDocTemplateFiles
-
reservedWordsMappings
-
templateDir
-
customTemplateDir
-
templateVersion
-
embeddedTemplateDir
-
commonTemplateDir
-
additionalProperties
-
vendorExtensions
-
supportingFiles
-
configFiles
-
cliOptions
-
languageArguments
-
skipOverwrite
protected boolean skipOverwrite -
removeOperationIdPrefix
protected boolean removeOperationIdPrefix -
supportsInheritance
protected boolean supportsInheritance -
supportsMixins
protected boolean supportsMixins -
supportedLibraries
-
library
-
sortParamsByRequiredFlag
-
ensureUniqueParams
-
allowUnicodeIdentifiers
-
gitUserId
-
gitRepoId
-
releaseNote
-
gitRepoBaseURL
-
httpUserAgent
-
hideGenerationTimestamp
-
templateEngine
protected io.swagger.codegen.v3.templates.TemplateEngine templateEngine -
specialCharReplacements
-
typeAliases
-
ignoreFilePathOverride
-
useOas2
protected boolean useOas2 -
ignoreImportMapping
protected boolean ignoreImportMapping
-
-
Constructor Details
-
DefaultCodegenConfig
public DefaultCodegenConfig()Default constructor. This method will map between Swagger type and language-specified type, as well as mapping between Swagger 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 Details
-
cliOptions
- Specified by:
cliOptionsin interfaceio.swagger.codegen.v3.CodegenConfig
-
processOpts
public void processOpts()- Specified by:
processOptsin interfaceio.swagger.codegen.v3.CodegenConfig
-
postProcessAllModels
- Specified by:
postProcessAllModelsin interfaceio.swagger.codegen.v3.CodegenConfig
-
postProcessAllCodegenModels
-
fixUpParentAndInterfaces
protected void fixUpParentAndInterfaces(io.swagger.codegen.v3.CodegenModel codegenModel, Map<String, io.swagger.codegen.v3.CodegenModel> allModels) Fix up all parent and interface CodegenModel references.- Parameters:
allModels-
-
postProcessModels
- Specified by:
postProcessModelsin interfaceio.swagger.codegen.v3.CodegenConfig
-
postProcessModelsEnum
post process enum defined in model's properties- Parameters:
objs- Map of models- Returns:
- maps of models with better enum support
-
processModelEnums
-
isPrimivite
-
updateCodegenModelEnumVars
protected void updateCodegenModelEnumVars(io.swagger.codegen.v3.CodegenModel codegenModel) update codegen property enum with proper naming convention and handling of numbers, special characters- Parameters:
codegenModel-
-
findCommonPrefixOfVars
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
Return the enum default value in the language specified format- Parameters:
value- enum variable namedatatype- data type- Returns:
- the default value for the enum
-
toEnumValue
Return the enum value in the language specified format e.g. status becomes "status"- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized value for enum
-
toEnumVarName
Return the sanitized variable name for enum- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized variable name for enum
-
postProcessOperations
- Specified by:
postProcessOperationsin interfaceio.swagger.codegen.v3.CodegenConfig
-
postProcessOperationsWithModels
public Map<String,Object> postProcessOperationsWithModels(Map<String, Object> objs, List<Object> allModels) - Specified by:
postProcessOperationsWithModelsin interfaceio.swagger.codegen.v3.CodegenConfig
-
postProcessSupportingFileData
- Specified by:
postProcessSupportingFileDatain interfaceio.swagger.codegen.v3.CodegenConfig
-
postProcessModelProperty
public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property) - Specified by:
postProcessModelPropertyin interfaceio.swagger.codegen.v3.CodegenConfig
-
postProcessParameter
public void postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter) - Specified by:
postProcessParameterin interfaceio.swagger.codegen.v3.CodegenConfig
-
preprocessOpenAPI
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) - Specified by:
preprocessOpenAPIin interfaceio.swagger.codegen.v3.CodegenConfig
-
processOpenAPI
public void processOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) - Specified by:
processOpenAPIin interfaceio.swagger.codegen.v3.CodegenConfig
-
processCompiler
public com.samskivert.mustache.Mustache.Compiler processCompiler(com.samskivert.mustache.Mustache.Compiler compiler) - Specified by:
processCompilerin interfaceio.swagger.codegen.v3.CodegenConfig
-
getTemplateEngine
public io.swagger.codegen.v3.templates.TemplateEngine getTemplateEngine()- Specified by:
getTemplateEnginein interfaceio.swagger.codegen.v3.CodegenConfig
-
escapeText
- Specified by:
escapeTextin interfaceio.swagger.codegen.v3.CodegenConfig
-
escapeUnsafeCharacters
override with any special text escaping logic to handle unsafe characters so as to avoid code injection- Specified by:
escapeUnsafeCharactersin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
input- String to be cleaned up- Returns:
- string with unsafe characters removed or escaped
-
escapeQuotationMark
Escape single and/or double quote to avoid code injection- Specified by:
escapeQuotationMarkin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
input- String to be cleaned up- Returns:
- string with quotation mark removed or escaped
-
defaultIncludes
- Specified by:
defaultIncludesin interfaceio.swagger.codegen.v3.CodegenConfig
-
typeMapping
- Specified by:
typeMappingin interfaceio.swagger.codegen.v3.CodegenConfig
-
instantiationTypes
- Specified by:
instantiationTypesin interfaceio.swagger.codegen.v3.CodegenConfig
-
reservedWords
- Specified by:
reservedWordsin interfaceio.swagger.codegen.v3.CodegenConfig
-
languageSpecificPrimitives
- Specified by:
languageSpecificPrimitivesin interfaceio.swagger.codegen.v3.CodegenConfig
-
importMapping
- Specified by:
importMappingin interfaceio.swagger.codegen.v3.CodegenConfig
-
testPackage
- Specified by:
testPackagein interfaceio.swagger.codegen.v3.CodegenConfig
-
modelPackage
- Specified by:
modelPackagein interfaceio.swagger.codegen.v3.CodegenConfig
-
apiPackage
- Specified by:
apiPackagein interfaceio.swagger.codegen.v3.CodegenConfig
-
fileSuffix
- Specified by:
fileSuffixin interfaceio.swagger.codegen.v3.CodegenConfig
-
templateDir
- Specified by:
templateDirin interfaceio.swagger.codegen.v3.CodegenConfig
-
embeddedTemplateDir
- Specified by:
embeddedTemplateDirin interfaceio.swagger.codegen.v3.CodegenConfig
-
customTemplateDir
- Specified by:
customTemplateDirin interfaceio.swagger.codegen.v3.CodegenConfig
-
getCommonTemplateDir
- Specified by:
getCommonTemplateDirin interfaceio.swagger.codegen.v3.CodegenConfig
-
setCommonTemplateDir
-
apiDocTemplateFiles
- Specified by:
apiDocTemplateFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
modelDocTemplateFiles
- Specified by:
modelDocTemplateFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
reservedWordsMappings
- Specified by:
reservedWordsMappingsin interfaceio.swagger.codegen.v3.CodegenConfig
-
apiTestTemplateFiles
- Specified by:
apiTestTemplateFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
modelTestTemplateFiles
- Specified by:
modelTestTemplateFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
apiTemplateFiles
- Specified by:
apiTemplateFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
modelTemplateFiles
- Specified by:
modelTemplateFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
apiFileFolder
- Specified by:
apiFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig
-
modelFileFolder
- Specified by:
modelFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig
-
apiTestFileFolder
- Specified by:
apiTestFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig
-
modelTestFileFolder
- Specified by:
modelTestFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig
-
apiDocFileFolder
- Specified by:
apiDocFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig
-
modelDocFileFolder
- Specified by:
modelDocFileFolderin interfaceio.swagger.codegen.v3.CodegenConfig
-
additionalProperties
- Specified by:
additionalPropertiesin interfaceio.swagger.codegen.v3.CodegenConfig
-
vendorExtensions
- Specified by:
vendorExtensionsin interfaceio.swagger.codegen.v3.CodegenConfig
-
supportingFiles
- Specified by:
supportingFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
configFiles
- Specified by:
configFilesin interfaceio.swagger.codegen.v3.CodegenConfig
-
outputFolder
- Specified by:
outputFolderin interfaceio.swagger.codegen.v3.CodegenConfig
-
setOutputDir
- Specified by:
setOutputDirin interfaceio.swagger.codegen.v3.CodegenConfig
-
getOutputDir
- Specified by:
getOutputDirin interfaceio.swagger.codegen.v3.CodegenConfig
-
getInputSpec
- Specified by:
getInputSpecin interfaceio.swagger.codegen.v3.CodegenConfig
-
setInputSpec
- Specified by:
setInputSpecin interfaceio.swagger.codegen.v3.CodegenConfig
-
getInputURL
- Specified by:
getInputURLin interfaceio.swagger.codegen.v3.CodegenConfig
-
setInputURL
- Specified by:
setInputURLin interfaceio.swagger.codegen.v3.CodegenConfig
-
setTemplateDir
-
getTemplateVersion
- Specified by:
getTemplateVersionin interfaceio.swagger.codegen.v3.CodegenConfig
-
setTemplateVersion
-
setModelPackage
-
setModelNamePrefix
-
setModelNameSuffix
-
setApiPackage
-
getSortParamsByRequiredFlag
-
setSortParamsByRequiredFlag
-
setEnsureUniqueParams
-
setAllowUnicodeIdentifiers
-
toRegularExpression
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
Return the file name of the Api Test- Specified by:
toApiFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toApiDocFilename
Return the file name of the Api Documentation- Specified by:
toApiDocFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toApiTestFilename
Return the file name of the Api Test- Specified by:
toApiTestFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
toApiVarName
Return the variable name in the Api- Specified by:
toApiVarNamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the varible name of the Api- Returns:
- the snake-cased variable name
-
toModelFilename
Return the capitalized file name of the model- Specified by:
toModelFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the model name- Returns:
- the file name of the model
-
toModelTestFilename
Return the capitalized file name of the model test- Specified by:
toModelTestFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the model name- Returns:
- the file name of the model
-
toModelDocFilename
Return the capitalized file name of the model documentation- Specified by:
toModelDocFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the model name- Returns:
- the file name of the model
-
toOperationId
Return the operation ID (method name)- Parameters:
operationId- operation ID- Returns:
- the sanitized method name
-
toVarName
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
Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.- Specified by:
toParamNamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- Codegen property object- Returns:
- the sanitized parameter name
-
toEnumName
Return the Enum name (e.g. StatusEnum given 'status')- Parameters:
property- Codegen property- Returns:
- the Enum name
-
escapeReservedWord
Return the escaped name of the reserved word- Specified by:
escapeReservedWordin interfaceio.swagger.codegen.v3.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
Return the fully-qualified "Model" name for import- Specified by:
toModelImportin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the "Model"- Returns:
- the fully-qualified "Model" name for import
-
toApiImport
Return the fully-qualified "Api" name for import- Specified by:
toApiImportin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the "Api"- Returns:
- the fully-qualified "Api" name for import
-
getSymbolName
Return the symbol name of a symbol- Parameters:
input- Symbol (e.g. $)- Returns:
- Symbol name (e.g. Dollar)
-
generateExamplePath
Return the example path- Specified by:
generateExamplePathin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
path- the path of the operationoperation- Swagger operation object- Returns:
- string presentation of the example path
-
toInstantiationType
Return the instantiation type of the property, especially for map and array- Parameters:
property- Swagger property object- Returns:
- string presentation of the instantiation type of the property
-
setParameterExampleValue
public void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p) Return the example value of the parameter.- Parameters:
p- Swagger property object
-
toExampleValue
Return the example value of the property- Parameters:
property- Schema property object- Returns:
- string presentation of the example value of the property
-
toDefaultValue
Return the default value of the property- Parameters:
property- Schema property object- Returns:
- string presentation of the default value of the property
-
toDefaultValueWithParam
Return the property initialized from a data object Useful for initialization with a plain object in Javascript- Parameters:
name- Name of the property objectproperty- openAPI schema object- Returns:
- string presentation of the default value of the property
-
getSchemaType
returns the swagger type for the property- Parameters:
property- Schema property object- Returns:
- string presentation of the type
-
snakeCase
Return the snake-case of the string- Parameters:
name- string to be snake-cased- Returns:
- snake-cased string
-
initialCaps
Capitalize the string- Parameters:
name- string to be capitalized- Returns:
- capitalized string
-
getTypeDeclaration
Output the type declaration of a given name- Specified by:
getTypeDeclarationin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- name- Returns:
- a string presentation of the type
-
getTypeDeclaration
Output the type declaration of the property- Specified by:
getTypeDeclarationin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
schema- Schema Property object- Returns:
- a string presentation of the property type
-
getAlias
Determine the type alias for the given type if it exists. This feature is only used for Java, because the language does not have a aliasing mechanism of its own.- 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
Output the Getter name for boolean property, e.g. getActive- Specified by:
toBooleanGetterin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the property- Returns:
- getter name based on naming convention
-
toGetter
Output the Getter name, e.g. getSize- Specified by:
toGetterin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the property- Returns:
- getter name based on naming convention
-
toSetter
Output the Getter name, e.g. getSize- Specified by:
toSetterin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the property- Returns:
- setter name based on naming convention
-
toApiName
Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty- Specified by:
toApiNamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the Api- Returns:
- capitalized Api name ending with "Api"
-
toModelName
Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.- Specified by:
toModelNamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the model- Returns:
- capitalized model name
-
fromModel
public io.swagger.codegen.v3.CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema schema) Convert Swagger Model object to Codegen Model object without providing all model definitions- Specified by:
fromModelin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the modelschema- Schema object- Returns:
- Codegen Model object
-
fromModel
public io.swagger.codegen.v3.CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String, io.swagger.v3.oas.models.media.Schema> allDefinitions) Convert Swagger Model object to Codegen Model object- Specified by:
fromModelin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- the name of the modelschema- Swagger Model objectallDefinitions- a map of all Swagger models from the spec- Returns:
- Codegen Model object
-
copyFirstAllOfProperties
protected boolean copyFirstAllOfProperties(io.swagger.v3.oas.models.media.Schema allOfSchema) -
processMapSchema
protected void processMapSchema(io.swagger.codegen.v3.CodegenModel codegenModel, String name, io.swagger.v3.oas.models.media.Schema schema) -
addAdditionPropertiesToCodeGenModel
protected void addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema) -
addProperties
-
getterAndSetterCapitalize
Camelize the method name of the getter and setter- Parameters:
name- string to be camelized- Returns:
- Camelized string
-
fromProperty
public io.swagger.codegen.v3.CodegenProperty fromProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema) Convert Swagger Property object to Codegen Property object- Parameters:
name- name of the propertypropertySchema- Schema object- Returns:
- Codegen Property object TODO : improve repeated code
-
setSchemaProperties
protected void setSchemaProperties(String name, io.swagger.codegen.v3.CodegenProperty codegenProperty, io.swagger.v3.oas.models.media.Schema schema) -
processPropertySchemaTypes
protected void processPropertySchemaTypes(String name, io.swagger.codegen.v3.CodegenProperty codegenProperty, io.swagger.v3.oas.models.media.Schema propertySchema) -
processPropertySchemaContainerTypes
protected void processPropertySchemaContainerTypes(io.swagger.codegen.v3.CodegenProperty codegenProperty, io.swagger.v3.oas.models.media.Schema propertySchema, String type) -
updatePropertyForArray
protected void updatePropertyForArray(io.swagger.codegen.v3.CodegenProperty property, io.swagger.codegen.v3.CodegenProperty innerProperty) Update property for array(list) container- Parameters:
property- Codegen propertyinnerProperty- Codegen inner property of map or list
-
updatePropertyForMap
protected void updatePropertyForMap(io.swagger.codegen.v3.CodegenProperty property, io.swagger.codegen.v3.CodegenProperty innerProperty) Update property for map container- Parameters:
property- Codegen propertyinnerProperty- Codegen inner property of map or list
-
isPropertyInnerMostEnum
Update property for map container- Parameters:
property- Codegen property- Returns:
- True if the inner most type is enum
-
getInnerEnumAllowableValues
-
updateDataTypeWithEnumForArray
protected void updateDataTypeWithEnumForArray(io.swagger.codegen.v3.CodegenProperty property) Update datatypeWithEnum for array container- Parameters:
property- Codegen property
-
updateDataTypeWithEnumForMap
protected void updateDataTypeWithEnumForMap(io.swagger.codegen.v3.CodegenProperty property) Update datatypeWithEnum for map container- Parameters:
property- Codegen property
-
setNonArrayMapProperty
-
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- Swagger Operation's responses- Returns:
- default method response or null if not found
-
fromOperation
public io.swagger.codegen.v3.CodegenOperation fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String, io.swagger.v3.oas.models.media.Schema> schemas) Convert Swagger Operation object to Codegen Operation object (without providing a Swagger object)- Specified by:
fromOperationin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
path- the path of the operationhttpMethod- HTTP methodoperation- Swagger operation objectschemas- a map of Swagger models- Returns:
- Codegen Operation object
-
fromOperation
public io.swagger.codegen.v3.CodegenOperation fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String, io.swagger.v3.oas.models.media.Schema> schemas, io.swagger.v3.oas.models.OpenAPI openAPI) Convert Swagger Operation object to Codegen Operation object- Specified by:
fromOperationin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
path- the path of the operationhttpMethod- HTTP methodoperation- Swagger operation objectschemas- a map of schemasopenAPI- a OpenAPI object representing the spec- Returns:
- Codegen Operation object
-
addOperationImports
-
fromResponse
public io.swagger.codegen.v3.CodegenResponse fromResponse(String responseCode, io.swagger.v3.oas.models.responses.ApiResponse response) Convert Swagger Response object to Codegen Response object- Parameters:
responseCode- HTTP response coderesponse- Swagger Response object- Returns:
- Codegen Response object
-
fromParameter
public io.swagger.codegen.v3.CodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter, Set<String> imports) Convert Swagger Parameter object to Codegen Parameter object- Parameters:
parameter- Swagger parameter objectimports- set of imports for library/package/module- Returns:
- Codegen Parameter object
-
fromRequestBody
-
isDataTypeBinary
-
isDataTypeFile
-
fromSecurity
public List<io.swagger.codegen.v3.CodegenSecurity> fromSecurity(Map<String, io.swagger.v3.oas.models.security.SecurityScheme> securitySchemeMap) Convert map of Swagger SecurityScheme objects to a list of Codegen Security objects- Specified by:
fromSecurityin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
securitySchemeMap- a map of Swagger SecuritySchemeDefinition object- Returns:
- a list of Codegen Security objects
-
setReservedWordsLowerCase
-
setReservedWords
-
isReservedWord
-
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 objectpath- the path of the operationhttpMethod- the HTTP method of the operation- Returns:
- the (generated) operationId
-
needToImport
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
-
addOperationToGroup
public void addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, io.swagger.codegen.v3.CodegenOperation co, Map<String, List<io.swagger.codegen.v3.CodegenOperation>> operations) Add operation to group- Specified by:
addOperationToGroupin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
tag- name of the tagresourcePath- path of the resourceoperation- Swagger Operation objectco- Codegen Operation objectoperations- map of Codegen operations
-
addParentContainer
public void addParentContainer(io.swagger.codegen.v3.CodegenModel codegenModel, String name, io.swagger.v3.oas.models.media.Schema schema) -
underscore
Underscore the given word. Copied from Twitter elephant bird https://github.com/twitter/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/util/Strings.java- Parameters:
word- The word- Returns:
- The underscored version of the word
-
dashize
Dashize the given word.- Parameters:
word- The word- Returns:
- The dashized version of the word, e.g. "my-name"
-
addImport
-
addVars
-
removeNonNameElementToCamelCase
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
Remove characters that is not good to be included in method name from the input and camelize it- Parameters:
name- string to be camelizenonNameElementPattern- a regex pattern of the characters that is not good to be included in name- Returns:
- camelized string
-
camelize
Camelize name (parameter, property, method, etc) with upper case for first letter copied from Twitter elephant bird https://github.com/twitter/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/util/Strings.java- Parameters:
word- string to be camelize- Returns:
- camelized string
-
camelize
Camelize name (parameter, property, method, etc)- Parameters:
word- string to be camelizelowercaseFirstLetter- lower case for first letter if set to true- Returns:
- camelized string
-
apiFilename
- Specified by:
apiFilenamein interfaceio.swagger.codegen.v3.CodegenConfig
-
apiDocFilename
Return the full path and API documentation file- Specified by:
apiDocFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
templateName- template nametag- tag- Returns:
- the API documentation file name with full path
-
apiTestFilename
Return the full path and API test file- Specified by:
apiTestFilenamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
templateName- template nametag- tag- Returns:
- the API test file name with full path
-
shouldOverwrite
- Specified by:
shouldOverwritein interfaceio.swagger.codegen.v3.CodegenConfig
-
isSkipOverwrite
public boolean isSkipOverwrite()- Specified by:
isSkipOverwritein interfaceio.swagger.codegen.v3.CodegenConfig
-
setSkipOverwrite
public void setSkipOverwrite(boolean skipOverwrite) - Specified by:
setSkipOverwritein interfaceio.swagger.codegen.v3.CodegenConfig
-
isRemoveOperationIdPrefix
public boolean isRemoveOperationIdPrefix()- Specified by:
isRemoveOperationIdPrefixin interfaceio.swagger.codegen.v3.CodegenConfig
-
setRemoveOperationIdPrefix
public void setRemoveOperationIdPrefix(boolean removeOperationIdPrefix) - Specified by:
setRemoveOperationIdPrefixin interfaceio.swagger.codegen.v3.CodegenConfig
-
supportedLibraries
All library languages supported. (key: library name, value: library description)- Specified by:
supportedLibrariesin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- the supported libraries
-
setLibrary
Set library template (sub-template).- Specified by:
setLibraryin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
library- Library template
-
getLibrary
Library template (sub-template).- Specified by:
getLibraryin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- Library template
-
setGitUserId
Set Git user ID.- Specified by:
setGitUserIdin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
gitUserId- Git user ID
-
getGitUserId
Git user ID- Specified by:
getGitUserIdin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- Git user ID
-
setGitRepoId
Set Git repo ID.- Specified by:
setGitRepoIdin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
gitRepoId- Git repo ID
-
getGitRepoId
Git repo ID- Specified by:
getGitRepoIdin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- Git repo ID
-
getGitRepoBaseURL
Git repo Base URL- Specified by:
getGitRepoBaseURLin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- Git repo Base URL
-
setGitRepoBaseURL
Set Git repo Base URL.- Specified by:
setGitRepoBaseURLin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
gitRepoBaseURL- Git repo Base URL
-
setReleaseNote
Set release note.- Specified by:
setReleaseNotein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
releaseNote- Release note
-
getReleaseNote
Release note- Specified by:
getReleaseNotein interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- Release note
-
setHttpUserAgent
Set HTTP user agent.- Specified by:
setHttpUserAgentin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
httpUserAgent- HTTP user agent
-
getHttpUserAgent
HTTP user agent- Specified by:
getHttpUserAgentin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- HTTP user agent
-
setHideGenerationTimestamp
Hide generation timestamp- Parameters:
hideGenerationTimestamp- flag to indicates if the generation timestamp should be hidden or not
-
getHideGenerationTimestamp
Hide generation timestamp- Returns:
- if the generation timestamp should be hidden or not
-
buildLibraryCliOption
-
sanitizeName
Sanitize name (parameter, property, method, etc)- Specified by:
sanitizeNamein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
name- string to be sanitize- Returns:
- sanitized string
-
sanitizeTag
Sanitize tag- Specified by:
sanitizeTagin interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
tag- Tag- Returns:
- Sanitized tag
-
addHandlebarHelpers
public void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars) - Specified by:
addHandlebarHelpersin interfaceio.swagger.codegen.v3.CodegenConfig
-
readLanguageArguments
- Specified by:
readLanguageArgumentsin interfaceio.swagger.codegen.v3.CodegenConfig
-
setLanguageArguments
- Specified by:
setLanguageArgumentsin interfaceio.swagger.codegen.v3.CodegenConfig
-
getLanguageArguments
- Specified by:
getLanguageArgumentsin interfaceio.swagger.codegen.v3.CodegenConfig
-
getArgumentsLocation
-
getOptionValue
-
writeOptional
-
writeOptional
public void writeOptional(String outputFolder, io.swagger.codegen.v3.SupportingFile supportingFile, boolean configFile) Only write if the file doesn't exist- Parameters:
outputFolder- Output foldersupportingFile- Supporting file
-
setParameterBooleanFlagWithCodegenProperty
public void setParameterBooleanFlagWithCodegenProperty(io.swagger.codegen.v3.CodegenParameter parameter, io.swagger.codegen.v3.CodegenProperty property) Set CodegenParameter boolean flag using CodegenProperty.- Parameters:
parameter- Codegen Parameterproperty- Codegen property
-
updateCodegenPropertyEnum
public void updateCodegenPropertyEnum(io.swagger.codegen.v3.CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)- Parameters:
var- list of CodegenProperty
-
addRegularExpressionDelimiter
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
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
Provides an override location, if any is specified, for the .swagger-codegen-ignore. This is originally intended for the first generation only.- Specified by:
getIgnoreFilePathOverridein interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- a string of the full path to an override ignore file.
-
setIgnoreFilePathOverride
Sets an override location for the .swagger-codegen.ignore location for the first code generation.- Specified by:
setIgnoreFilePathOverridein interfaceio.swagger.codegen.v3.CodegenConfig- Parameters:
ignoreFileOverride- The full path to an ignore file
-
setUseOas2
public void setUseOas2(boolean useOas2) -
getDefaultTemplateDir
-
convertPropertyToBoolean
-
writePropertyBack
-
addOption
-
addOption
-
addSwitch
-
getContentType
-
getSchemaFromBody
protected io.swagger.v3.oas.models.media.Schema getSchemaFromBody(io.swagger.v3.oas.models.parameters.RequestBody requestBody) -
getSchemaFromResponse
protected io.swagger.v3.oas.models.media.Schema getSchemaFromResponse(io.swagger.v3.oas.models.responses.ApiResponse response) -
getSchemaFromParameter
protected io.swagger.v3.oas.models.media.Schema getSchemaFromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter) -
getParameterFromRef
protected io.swagger.v3.oas.models.parameters.Parameter getParameterFromRef(String ref, io.swagger.v3.oas.models.OpenAPI openAPI) -
setTemplateEngine
protected void setTemplateEngine() -
getTemplateDir
-
addConsumesInfo
protected void addConsumesInfo(io.swagger.v3.oas.models.Operation operation, io.swagger.codegen.v3.CodegenOperation codegenOperation, io.swagger.v3.oas.models.OpenAPI openAPI) -
configureDataForTestTemplate
protected void configureDataForTestTemplate(io.swagger.codegen.v3.CodegenOperation codegenOperation) -
getConsumesInfo
-
addProducesInfo
protected void addProducesInfo(io.swagger.v3.oas.models.responses.ApiResponse response, io.swagger.codegen.v3.CodegenOperation codegenOperation) -
getProducesInfo
-
detectParent
-
getParentName
-
getCollectionFormat
-
isObjectSchema
public boolean isObjectSchema(io.swagger.v3.oas.models.media.Schema schema) -
hasSchemaProperties
protected static boolean hasSchemaProperties(io.swagger.v3.oas.models.media.Schema schema) -
hasTrueAdditionalProperties
protected static boolean hasTrueAdditionalProperties(io.swagger.v3.oas.models.media.Schema schema) -
configuresParameterForMediaType
protected void configuresParameterForMediaType(io.swagger.codegen.v3.CodegenOperation codegenOperation, List<io.swagger.codegen.v3.CodegenContent> codegenContents) -
addParameters
protected void addParameters(io.swagger.codegen.v3.CodegenContent codegenContent, List<io.swagger.codegen.v3.CodegenParameter> codegenParameters) -
addCodegenContentParameters
protected void addCodegenContentParameters(io.swagger.codegen.v3.CodegenOperation codegenOperation, List<io.swagger.codegen.v3.CodegenContent> codegenContents) -
ensureUniqueParameters
protected void ensureUniqueParameters(List<io.swagger.codegen.v3.CodegenParameter> codegenParameters) -
setParameterNullable
protected void setParameterNullable(io.swagger.codegen.v3.CodegenParameter parameter, io.swagger.codegen.v3.CodegenProperty property) -
setParameterJson
protected void setParameterJson(io.swagger.codegen.v3.CodegenParameter codegenParameter, io.swagger.v3.oas.models.media.Schema parameterSchema) -
isFileTypeSchema
protected boolean isFileTypeSchema(io.swagger.v3.oas.models.media.Schema schema) -
needsUnflattenedSpec
public boolean needsUnflattenedSpec()- Specified by:
needsUnflattenedSpecin interfaceio.swagger.codegen.v3.CodegenConfig
-
setUnflattenedOpenAPI
public void setUnflattenedOpenAPI(io.swagger.v3.oas.models.OpenAPI unflattenedOpenAPI) - Specified by:
setUnflattenedOpenAPIin interfaceio.swagger.codegen.v3.CodegenConfig
-
getIgnoreImportMapping
public boolean getIgnoreImportMapping()- Specified by:
getIgnoreImportMappingin interfaceio.swagger.codegen.v3.CodegenConfig
-
setIgnoreImportMapping
public void setIgnoreImportMapping(boolean ignoreImportMapping) - Specified by:
setIgnoreImportMappingin interfaceio.swagger.codegen.v3.CodegenConfig
-
defaultIgnoreImportMappingOption
public boolean defaultIgnoreImportMappingOption()- Specified by:
defaultIgnoreImportMappingOptionin interfaceio.swagger.codegen.v3.CodegenConfig
-
getSchemaHandler
public io.swagger.codegen.v3.ISchemaHandler getSchemaHandler()- Specified by:
getSchemaHandlerin interfaceio.swagger.codegen.v3.CodegenConfig
-
getOpenAPI
public io.swagger.v3.oas.models.OpenAPI getOpenAPI()
-