Skip to main content

Documentation for the swift5 Generator

METADATA

PropertyValueNotes
generator nameswift5pass this to the generate command after -g
generator stabilitySTABLE
generator typeCLIENT
generator languageSwift
generator default templating enginemustache
helpTxtGenerates a Swift 5.x client library.

CONFIG OPTIONS

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
apiNamePrefixPrefix that will be appended to all API names ('tags'). Default: empty string. e.g. Pet => Pet.null
disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
generateModelAdditionalPropertiesGenerate model additional properties (default: true)true
hashableModelsMake hashable models (default: true)true
hideGenerationTimestampHides the generation timestamp when files are generated.true
legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
lenientTypeCastAccept and cast values for simple types (string->bool, string->int, int->string)false
libraryLibrary template (sub-template) to use
urlsession
[DEFAULT] HTTP client: URLSession
alamofire
HTTP client: Alamofire
vapor
HTTP client: Vapor
urlsession
mapFileBinaryToData[WARNING] This option will be removed and enabled by default in the future once we've enhanced the code to work with Data in all the different situations. Map File and Binary to Data (default: false)false
nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false)null
objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
podAuthorsAuthors used for Podspecnull
podDescriptionDescription used for Podspecnull
podDocumentationURLDocumentation URL used for Podspecnull
podHomepageHomepage used for Podspecnull
podLicenseLicense used for Podspecnull
podScreenshotsScreenshots used for Podspecnull
podSocialMediaURLSocial Media URL used for Podspecnull
podSourceSource information used for Podspecnull
podSummarySummary used for Podspecnull
podVersionVersion used for Podspecnull
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
projectNameProject name in Xcodenull
readonlyPropertiesMake properties readonly (default: false)null
responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift, Result, Combine, AsyncAwait are available.null
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
swiftPackagePathSet a custom source path instead of OpenAPIClient/Classes/OpenAPIs.null
swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
useBacktickEscapesEscape reserved words using backticks (default: false)false
useClassesUse final classes for models instead of structs (default: false)false
useCustomDateWithoutTimeUses a custom type to decode and encode dates without time information to support OpenAPIs date format (default: false)false
useJsonEncodableMake models conform to JSONEncodable protocol (default: true)true
useSPMFileStructureUse SPM file structure and set the source path to Sources/{{projectName}} (default: false).null
validatableMake validation rules and validator for model properies (default: true)true

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated By

LANGUAGE PRIMITIVES

  • Any
  • AnyCodable
  • AnyObject
  • Bool
  • Character
  • Data
  • Date
  • Decimal
  • Double
  • Float
  • Int
  • Int32
  • Int64
  • OpenAPIDateWithoutTime
  • String
  • URL
  • UUID
  • Void

RESERVED WORDS

  • #available
  • #colorLiteral
  • #column
  • #else
  • #elseif
  • #endif
  • #file
  • #fileLiteral
  • #function
  • #if
  • #imageLiteral
  • #line
  • #selector
  • #sourceLocation
  • Any
  • AnyObject
  • Array
  • Bool
  • COLUMN
  • Character
  • Class
  • ClosedRange
  • Codable
  • CountableClosedRange
  • CountableRange
  • Data
  • Decodable
  • Dictionary
  • Double
  • Encodable
  • Error
  • ErrorResponse
  • FILE
  • FUNCTION
  • Float
  • Float32
  • Float64
  • Float80
  • Int
  • Int16
  • Int32
  • Int64
  • Int8
  • LINE
  • OptionSet
  • Optional
  • Protocol
  • Range
  • Response
  • Self
  • Set
  • StaticString
  • String
  • Type
  • UInt
  • UInt16
  • UInt32
  • UInt64
  • UInt8
  • URL
  • Unicode
  • Void
  • _
  • as
  • associatedtype
  • associativity
  • break
  • case
  • catch
  • class
  • continue
  • convenience
  • default
  • defer
  • deinit
  • didSet
  • do
  • dynamic
  • dynamicType
  • else
  • enum
  • extension
  • fallthrough
  • false
  • fileprivate
  • final
  • for
  • func
  • get
  • guard
  • if
  • import
  • in
  • indirect
  • infix
  • init
  • inout
  • internal
  • is
  • lazy
  • left
  • let
  • mutating
  • nil
  • none
  • nonmutating
  • open
  • operator
  • optional
  • override
  • postfix
  • precedence
  • prefix
  • private
  • protocol
  • public
  • repeat
  • required
  • rethrows
  • return
  • right
  • self
  • set
  • static
  • struct
  • subscript
  • super
  • switch
  • throw
  • throws
  • true
  • try
  • typealias
  • unowned
  • var
  • weak
  • where
  • while
  • willSet

FEATURE SET

Client Modification Feature

NameSupportedDefined By
BasePathToolingExtension
AuthorizationsToolingExtension
UserAgentToolingExtension
MockServerToolingExtension

Data Type Feature

NameSupportedDefined By
CustomOAS2,OAS3
Int32OAS2,OAS3
Int64OAS2,OAS3
FloatOAS2,OAS3
DoubleOAS2,OAS3
DecimalToolingExtension
StringOAS2,OAS3
ByteOAS2,OAS3
BinaryOAS2,OAS3
BooleanOAS2,OAS3
DateOAS2,OAS3
DateTimeOAS2,OAS3
PasswordOAS2,OAS3
FileOAS2
Uuid
ArrayOAS2,OAS3
NullOAS3
AnyTypeOAS2,OAS3
ObjectOAS2,OAS3
MapsToolingExtension
CollectionFormatOAS2
CollectionFormatMultiOAS2
EnumOAS2,OAS3
ArrayOfEnumToolingExtension
ArrayOfModelToolingExtension
ArrayOfCollectionOfPrimitivesToolingExtension
ArrayOfCollectionOfModelToolingExtension
ArrayOfCollectionOfEnumToolingExtension
MapOfEnumToolingExtension
MapOfModelToolingExtension
MapOfCollectionOfPrimitivesToolingExtension
MapOfCollectionOfModelToolingExtension
MapOfCollectionOfEnumToolingExtension

Documentation Feature

NameSupportedDefined By
ReadmeToolingExtension
ModelToolingExtension
ApiToolingExtension

Global Feature

NameSupportedDefined By
HostOAS2,OAS3
BasePathOAS2,OAS3
InfoOAS2,OAS3
SchemesOAS2,OAS3
PartialSchemesOAS2,OAS3
ConsumesOAS2
ProducesOAS2
ExternalDocumentationOAS2,OAS3
ExamplesOAS2,OAS3
XMLStructureDefinitionsOAS2,OAS3
MultiServerOAS3
ParameterizedServerOAS3
ParameterStylingOAS3
CallbacksOAS3
LinkObjectsOAS3

Parameter Feature

NameSupportedDefined By
PathOAS2,OAS3
QueryOAS2,OAS3
HeaderOAS2,OAS3
BodyOAS2
FormUnencodedOAS2
FormMultipartOAS2
CookieOAS3

Schema Support Feature

NameSupportedDefined By
SimpleOAS2,OAS3
CompositeOAS2,OAS3
PolymorphismOAS2,OAS3
UnionOAS3
allOfOAS2,OAS3
anyOfOAS3
oneOfOAS3
notOAS3

Security Feature

NameSupportedDefined By
BasicAuthOAS2,OAS3
ApiKeyOAS2,OAS3
OpenIDConnectOAS3
BearerTokenOAS3
OAuth2_ImplicitOAS2,OAS3
OAuth2_PasswordOAS2,OAS3
OAuth2_ClientCredentialsOAS2,OAS3
OAuth2_AuthorizationCodeOAS2,OAS3
SignatureAuthOAS3
AWSV4SignatureToolingExtension

Wire Format Feature

NameSupportedDefined By
JSONOAS2,OAS3
XMLOAS2,OAS3
PROTOBUFToolingExtension
CustomOAS2,OAS3