How to sort the keys of your JSON using Codable
Swift version: 5.2
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.
SPONSORED Are you tired of wasting time debugging your Swift app? Instabug’s SDK is here to help you minimize debugging time by providing you with complete device details, network logs, and reproduction steps with every bug report. All data is attached automatically, and it only takes a line of code to setup. Start your free trial now and get 3 months off exclusively for the Hacking with Swift Community.
Sponsor Hacking with Swift and reach the world's largest Swift community!
Available from iOS 8.0
Similar solutions…
- How to run code when your app is terminated
- How to localize your iOS app
- How to change your app icon dynamically with setAlternateIconName()
- How to detect images using ARImageTrackingConfiguration
- SwiftUI tips and tricks
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
