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.
SPONSOR Tired of wasting time debugging your Swift app? Instabug’s SDK is here to help you minimize your debugging time by providing you with complete device details, network logs, and reproduction steps with every bug report. All data is attached automatically. It only takes a line of code to setup. Get started for free.
Available from iOS 8.0
Did this solution work for you? Please pass it on!
Other people are reading…
- How to check for valid method input using the guard keyword
- How to add Markdown comments to your code
- How to loop over non-nil items in an array
- How to add raw values to enums
- How to list all cases in an enum using CaseIterable
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
