How to sort the keys of your JSON using Codable
Swift version: 5.6
When you use JSONEncoder and Codable to create JSON from your Swift data, your properties are not guaranteed to be written out in any particular order. This is usually 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, based on the names of each of your properties.
BUILD THE ULTIMATE PORTFOLIO APP Most Swift tutorials help you solve one specific problem, but in my Ultimate Portfolio App series I show you how to get all the best practices into a single app: architecture, testing, performance, accessibility, localization, project organization, and so much more, all while building a SwiftUI app that works on iOS, macOS and watchOS.
Sponsor Hacking with Swift and reach the world's largest Swift community!
Available from iOS 8.0
Similar solutions…
- How to sort an array using sort()
- How to specify default values for dictionary keys
- How to decode JSON from your app bundle the easy way
- How to reverse sort an array
- How to download JSON from the internet and decode it into any Codable type
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
