How to sort the keys of your JSON using Codable
Swift version: 5.0
When you use JSONEncoder and Codable to create JSON from your Swift data, your properties get written out in the order they appear inside your class. This is nearly always fine, because relying on key ordering in your JSON is almost certainly a bad idea.
However, if you’re debugging a large type and it’s hard to dig through keys to find what you want, JSONEncoder has the perfect option for you: you can sort your JSON keys alphabetically.
To make it happen, change the outputFormatting property of your JSONEncoder object to be .sortedKeys, like this:
let encoder = JSONEncoder()
encoder.outputFormatting = .sortedKeysNow any JSON you produce will use alphabetical order for your keys rather than using their natural order inside your type.
LEARN SWIFTUI FOR FREE I wrote a massive, free SwiftUI tutorial collection, and also have a growing list of free SwiftUI tutorials on YouTube – get started today!
Available from iOS 8.0
Did this solution work for you? Please pass it on!
Other people are reading…
- How to check whether an integer lies inside a range
- How to install a beta version of Swift
- What are implicitly unwrapped optionals?
- How to create hash values from objects using Hasher
- How to fix the error “protocol can only be used as a generic constraint because it has Self or associated type requirements”
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
