How to format JSON using Codable and pretty printing

Paul Hudson    February 13th 2018    @twostraws

When you use JSONEncoder and Codable to create JSON from your Swift data, it comes out in a compressed format by default – it has all its excess whitespace removed. This makes it efficient for transferring over the network, but hard to debug because it’s just a big jumble of words.

For debugging purposes, it’s a good idea to enable pretty printing for your encoded JSON, which will tell JSONEncoder to separate everything using line breaks and spaces so you can read it more easily.

To make this happen, set the outputFormatting property of your JSON encoder to be .prettyPrinted, like this:

let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted

Available from iOS 8.0

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

Tweet

Other people are reading…

• How to fix the error “protocol can only be used as a generic constraint because it has Self or associated type requirements”
• What are designated initializers?
• Removing matching elements from a collection: removeAll(where:)
• How to convert a string to an NSString
• What is a protocol associated type?

About the Swift Knowledge Base

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