What XML to Swift does
XML to Swift turns a sample XML document into Swift code: one Codable struct per object, with a type for every field inferred from the value in the sample.
XML to Swift examples
The built-in sample
Input
<users><user id="1"><name>Ada</name></user><user id="2"><name>Lin</name></user></users>Output
struct Root: Codable {
let _id: String
let name: String
}This is the input that the Load sample button fills in.
Attributes, repeated elements and empty elements
Input
<order id="7" paid="false"><total>19.5</total><item sku="A1"><qty>2</qty></item><item sku="B2"><qty>1</qty><gift/></item><note/></order>Output
struct Item: Codable {
let _sku: String
let qty: String
let gift: String
}
struct Root: Codable {
let _id: String
let _paid: String
let total: String
let item: [Item]
let note: String
}In the sample, id, paid and sku are attributes, item repeats, and gift and note are empty elements. Every value is typed as a string, because XML does not carry types.
Each output was produced by running this tool on the input above it.
How it works
The sample is walked recursively and each value is mapped to a Swift type:
| Sample value | Swift type |
|---|---|
| String | String |
| Whole number | Int |
| Decimal number | Double |
| true / false | Bool |
| null, or an empty array’s items | Any |
| Array of T | [T] |
| Object | a new named type |
XML has no data types, so every leaf value is generated as the Swift string type. Attributes become fields too: the @ prefix becomes an underscore (_id). Repeated elements become lists, and the root element itself is always called Root.
Reading XML into the generated types
Foundation has no XML decoder for Codable types; XMLParser is event-based. The structs fit XML that you first convert to JSON, or a third-party XML decoder.
Details and limits
- A property typed
Anydoes not compile in aCodablestruct. The generator usesAnyfor null values and empty arrays; replace it with an optional of the real type, such asString?. - Decoding fails if a key is missing from the data. Declare such properties as optionals.
- A renamed key (
order-idbecomesorder_id) needs aCodingKeysenum that maps the property to the original key. - A type is named after the key that holds the object:
itemsgives a type calledItems, with no attempt to make it singular. The top-level type is alwaysRoot. - If two different objects sit under the same key name in different places, two types with the same name are generated. Rename one of them.
- Objects in an array are merged into one type. A field that only some of them have is still generated as a required field.
- Input that is not valid XML stops the tool, and the status line shows where the problem is. The XML Validator page lists the usual causes.
Questions
Is my data uploaded when I use XML to Swift?
No. The tool runs in your browser, so what you paste or open is processed on your own device and is not sent to a server.
What does XML to Swift do?
XML to Swift turns a sample XML document into Swift code: one Codable struct per object, with a type for every field inferred from the value in the sample.
Are there any limits I should know about?
A property typed Any does not compile in a Codable struct. The generator uses Any for null values and empty arrays; replace it with an optional of the real type, such as String?. Decoding fails if a key is missing from the data. Declare such properties as optionals.
Is there a size limit?
There is no fixed size limit. Everything happens on your device, so very large inputs depend on its memory and can take longer on a phone than on a computer.
Does it work on phones, and is it free?
Yes. It works in any current browser on Android phones, iPhones, tablets and computers. It is free and needs no account or sign-up.