How to sort the keys of your JSON using Codable

Paul Hudson    February 13th 2018    @twostraws

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 = .sortedKeys

Now any JSON you produce will use alphabetical order for your keys rather than using their natural order inside your type.

Available from iOS 8.0

Did this solution work for you? Please pass it on!

Tweet

Other people are reading…

• How to compare two tuples for equality
• What is a lazy sequence?
• How to check for valid method input using the guard keyword
• How to safely use reference types inside value types with isKnownUniquelyReferenced()
• How to conform to the Equatable protocol

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.