Package io.swagger.codegen.languages

Class SwiftCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.SwiftCodegen

All Implemented Interfaces:

CodegenConfig

public class SwiftCodegen
extends DefaultCodegen
implements CodegenConfig

Swift (2.x) generator is no longer actively maintained. Please use 'swift3' or 'swift4' generator instead.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_POD_AUTHORS
protected static String	LIBRARY_PROMISE_KIT
protected static String	LIBRARY_RX_SWIFT
static String	POD_AUTHORS
static String	POD_DESCRIPTION
static String	POD_DOCSET_URL
static String	POD_DOCUMENTATION_URL
static String	POD_HOMEPAGE
static String	POD_LICENSE
static String	POD_SCREENSHOTS
static String	POD_SOCIAL_MEDIA_URL
static String	POD_SOURCE
static String	POD_SUMMARY
static String	PROJECT_NAME
protected String	projectName
static String	RESPONSE_AS
protected static String[]	RESPONSE_LIBRARIES
protected String[]	responseAs
protected String	sourceFolder
static String	SWIFT_USE_API_NAMESPACE
protected boolean	swiftUseApiNamespace
static String	UNWRAP_REQUIRED
protected boolean	unwrapRequired

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, LOGGER, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipAliasGeneration, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor	Description
SwiftCodegen()

Method Summary

Modifier and Type	Method	Description
String	apiFileFolder()
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	escapeUnsafeCharacters(String input)	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions, io.swagger.models.Swagger swagger)	Convert Swagger Operation object to Codegen Operation object
CodegenProperty	fromProperty(String name, io.swagger.models.properties.Property p)	Convert Swagger Property object to Codegen Property object
String	getHelp()
String	getName()
String	getSwaggerType(io.swagger.models.properties.Property p)	returns the swagger type for the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.models.properties.Property p)	Output the type declaration of the property
boolean	isDataTypeBinary(String dataType)
boolean	isDataTypeFile(String dataType)
protected boolean	isReservedWord(String word)
String	modelFileFolder()
Map<String,Object>	postProcessModels(Map<String,Object> objs)
void	processOpts()
void	setProjectName(String projectName)
void	setResponseAs(String[] responseAs)
void	setSwiftUseApiNamespace(boolean swiftUseApiNamespace)
void	setUnwrapRequired(boolean unwrapRequired)
String	toApiName(String name)	Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toDefaultValue(io.swagger.models.properties.Property p)	Return the default value of the property
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 name, String datatype)	Return the sanitized variable name for enum
String	toInstantiationType(io.swagger.models.properties.Property p)	Return the instantiation type of the property, especially for map and array
String	toModelFilename(String name)	Return the capitalized file name of the model
String	toModelName(String name)	Output the proper model name (capitalized)
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	toSwiftyEnumName(String value)
String	toVarName(String name)	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class io.swagger.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIgnoreImportMappingOption, defaultIncludes, embeddedTemplateDir, ensureUniqueName, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromModel, fromOperation, fromParameter, fromResponse, fromSecurity, generateExamplePath, getAlias, getAllAliases, getCommonTemplateDir, getExamples, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterDataType, getReleaseNote, getSkipAliasGeneration, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isHideGenerationTimestamp, isModelObject, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, isUsingFlattenSpec, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperties, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processCompiler, processSwagger, readRefModelParameter, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipAliasGeneration, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, titleCase, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIgnoreImportMappingOption, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSkipAliasGeneration, getTypeDeclaration, importMapping, instantiationTypes, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isUsingFlattenSpec, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processCompiler, processSwagger, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipAliasGeneration, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

Field Detail

PROJECT_NAME

public static final String PROJECT_NAME

See Also:

Constant Field Values

RESPONSE_AS

public static final String RESPONSE_AS

See Also:

Constant Field Values

UNWRAP_REQUIRED

public static final String UNWRAP_REQUIRED

See Also:

Constant Field Values

POD_SOURCE

public static final String POD_SOURCE

See Also:

Constant Field Values

POD_AUTHORS

public static final String POD_AUTHORS

See Also:

Constant Field Values

POD_SOCIAL_MEDIA_URL

public static final String POD_SOCIAL_MEDIA_URL

See Also:

Constant Field Values

POD_DOCSET_URL

public static final String POD_DOCSET_URL

See Also:

Constant Field Values

POD_LICENSE

public static final String POD_LICENSE

See Also:

Constant Field Values

POD_HOMEPAGE

public static final String POD_HOMEPAGE

See Also:

Constant Field Values

POD_SUMMARY

public static final String POD_SUMMARY

See Also:

Constant Field Values

POD_DESCRIPTION

public static final String POD_DESCRIPTION

See Also:

Constant Field Values

POD_SCREENSHOTS

public static final String POD_SCREENSHOTS

See Also:

Constant Field Values

POD_DOCUMENTATION_URL

public static final String POD_DOCUMENTATION_URL

See Also:

Constant Field Values

SWIFT_USE_API_NAMESPACE

public static final String SWIFT_USE_API_NAMESPACE

See Also:

Constant Field Values

DEFAULT_POD_AUTHORS

public static final String DEFAULT_POD_AUTHORS

See Also:

Constant Field Values

LIBRARY_PROMISE_KIT

protected static final String LIBRARY_PROMISE_KIT

See Also:

Constant Field Values

LIBRARY_RX_SWIFT

protected static final String LIBRARY_RX_SWIFT

See Also:

Constant Field Values

RESPONSE_LIBRARIES

protected static final String[] RESPONSE_LIBRARIES

projectName

protected String projectName

unwrapRequired

protected boolean unwrapRequired

swiftUseApiNamespace

protected boolean swiftUseApiNamespace

responseAs

protected String[] responseAs

sourceFolder

protected String sourceFolder

Constructor Detail

SwiftCodegen

public SwiftCodegen()

Method Detail

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

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

isReservedWord

protected boolean isReservedWord(String word)

Overrides:

isReservedWord in class DefaultCodegen

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

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

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

getTypeDeclaration

public String getTypeDeclaration(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

p - Swagger Property object

Returns:

a string presentation of the property type

getSwaggerType

public String getSwaggerType(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

returns the swagger type for the property

Overrides:

getSwaggerType in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the type

isDataTypeFile

public boolean isDataTypeFile(String dataType)

Overrides:

isDataTypeFile in class DefaultCodegen

isDataTypeBinary

public boolean isDataTypeBinary(String dataType)

Overrides:

isDataTypeBinary in class DefaultCodegen

toModelName

public String toModelName(String name)

Output the proper model name (capitalized)

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toDefaultValue

public String toDefaultValue(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the default value of the property

toInstantiationType

public String toInstantiationType(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

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

Overrides:

toInstantiationType in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the instantiation type of the property

fromProperty

public CodegenProperty fromProperty(String name,
                                    io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Convert Swagger Property object to Codegen Property object

Overrides:

fromProperty in class DefaultCodegen

Parameters:

name - name of the property

p - Swagger property object

Returns:

Codegen Property object

toSwiftyEnumName

public String toSwiftyEnumName(String value)

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

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

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toOperationId

public String toOperationId(String operationId)

Description copied from class: DefaultCodegen

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegen

Parameters:

operationId - operation ID

Returns:

the sanitized method name

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegen

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

Overrides:

toVarName in class DefaultCodegen

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegen

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

Specified by:

toParamName in interface CodegenConfig

Overrides:

toParamName in class DefaultCodegen

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

fromOperation

public CodegenOperation fromOperation(String path,
                                      String httpMethod,
                                      io.swagger.models.Operation operation,
                                      Map<String,io.swagger.models.Model> definitions,
                                      io.swagger.models.Swagger swagger)

Description copied from class: DefaultCodegen

Convert Swagger Operation object to Codegen Operation object

Specified by:

fromOperation in interface CodegenConfig

Overrides:

fromOperation in class DefaultCodegen

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - Swagger operation object

definitions - a map of Swagger models

swagger - a Swagger object representing the spec

Returns:

Codegen Operation object

setProjectName

public void setProjectName(String projectName)

setUnwrapRequired

public void setUnwrapRequired(boolean unwrapRequired)

setResponseAs

public void setResponseAs(String[] responseAs)

setSwiftUseApiNamespace

public void setSwiftUseApiNamespace(boolean swiftUseApiNamespace)

toEnumValue

public String toEnumValue(String value,
                          String datatype)

Description copied from class: DefaultCodegen

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

Overrides:

toEnumValue in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

toEnumDefaultValue

public String toEnumDefaultValue(String value,
                                 String datatype)

Description copied from class: DefaultCodegen

Return the enum default value in the language specified format

Overrides:

toEnumDefaultValue in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the default value for the enum

toEnumVarName

public String toEnumVarName(String name,
                            String datatype)

Description copied from class: DefaultCodegen

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class DefaultCodegen

Parameters:

name - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

toEnumName

public String toEnumName(CodegenProperty property)

Description copied from class: DefaultCodegen

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

Overrides:

toEnumName in class DefaultCodegen

Parameters:

property - Codegen property

Returns:

the Enum name

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegen

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegen

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

Specified by:

escapeUnsafeCharacters in interface CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped