ZippyJSON Documentation

ZippyJSON is designed to optimize JSON parsing performance, which can often be a bottleneck in data delivery.

Decision Guide:

1. Default: Start with the standard JSONDecoder as it is battle-tested.
2. Profile: If you identify JSON parsing as a performance bottleneck, measure the time taken.
3. Estimate: A rule of thumb is to divide the current parsing time by 4 to approximate the time with ZippyJSON.
4. Switch: If that difference is significant to your application's user experience, switch to ZippyJSONDecoder.

Note: If you are targeting iOS 17+, stick with the native JSONDecoder as it is faster than ZippyJSON on that platform.

To install ZippyJSON using CocoaPods, add the following line to your Podfile:

pod 'ZippyJSON'

If you wish to suppress all warnings during installation, use:

pod 'ZippyJSON', :inhibit_warnings => true

For iOS projects, you can add ZippyJSON using the Swift Package Manager (SwiftPM). Use the following repository URL:

https://github.com/michaeleisel/ZippyJSON

ZippyJSON provides ZippyJSONDecoder, which has the exact same API as Apple's JSONDecoder. To use it, import the module and replace the standard decoder initialization.

Important: When measuring performance, ensure you are building for release mode.

Note on Compatibility: For iOS 17+, Apple's JSONDecoder is faster than ZippyJSON. This library is intended for use on versions prior to iOS 17 to improve parsing performance.

import ZippyJSON

// Instead of:
// let decoder = JSONDecoder()

// Use:
let decoder = ZippyJSONDecoder()