Parse JSON data, simple, lightweight & without noise.

Enjoy the playground, it also contains some tests & an example json file.

Example Usage

// init with String, specifying single or double quotes
JSONX(with:"{'name':'Khan Solo'}", usesSingleQuotes:true)

// init with file path
JSONX(with:path)

// init with file URL
JSONX(with:url)

// init with Data
JSONX(with:data)

// init with Dictionary<String, Any>
JSONX(with:["name":"Khan-Solo", "level":50, "skills":[1,2,3], "droids":["shiny":9]])

Accessors Types

Supported Data Types: Bool, UInt,/Int, Float/Double, String, Array, Dictionary, Raw uncasted format

All accessor functions have the ability to define a default value:

// without default value
jsonx.asString("thisKeyDoesNotExist") // returns nil

// with default value
jsonx.asString("thisKeyDoesNotExist", default:"Default string") // returns "Default string"

Search using key paths:

{
    "parent": {
        "child": {
            "puppy": {
                "name": "voffy"
            }
        }
    }
}

jsonx.asString(inKeyPath:"parent.child.puppy.name") // returns "voffy"

Simple JSON -> Swift Struct model mapping

{
    "Person": {
        "name": "Khan Solo",
        "age": 99
    }
}

struct PersonModel
{
    var name:String?
    var age:Int?

    static func `init`(jsonx:JSONX)
    -> PersonModel
    {
        var pm:PersonModel = PersonModel()

        pm.name = jsonx.asString("name", default:"Johnny Appleseed")
        pm.age = jsonx.asInt("age", default:0)

        return pm
    }
}

PersonModel.init(jsonx:myJSONXObject)

Tailored for your Swifty needs!

Just type .as to see the function lookup with prefixed function names :-)

Performance

The provided XCTest measures the performance when it comes to finding a key in a hierarchy. Usually you would only do this once and cache the value, but it is interesting to see how JSONX compares to other alternatives. JSONX is actually so fast, you can use it in realtime without worrying about performance!

Tests were run on a MacBook Pro (Retina, 15-inch, Late 2013), 16 GB 1600 MHz DDR3, macOS 10.11.6 (15G1217)

    jsonx.asString(inKeyPath:"key1.key2.key3.key4.key5")

    jayson["key1"]["key2"]["key3"]["key4"]["key5"].string

swiftyjson["key1"]["key2"]["key3"]["key4"]["key5"].string

The test measures each call 10000 times, lower result is better & faster.

By average time JSONX is 2.08x faster than JAYSON and 14.06x faster than SwiftyJSON.

By passed time JSONX is 1.82x faster than JAYSON, and 11.26x faster than SwiftyJSON.

What’s New?

• Version 1.1 improves performance as well as minor refactorings.

Requirements

• Swift Version 3.0.1
• ARC
• macOS 10.11 and later
• iOS 9.0 and later
• tvOS 9.0 and later

How to Install

There is no framework/library distibution, I recommend that you add the JSONX/Sources to your project. As this will allow you to easily find & read the JSONX API, it will also allow JSONX to compile using your apps build settings.

• Git: run git clone https://github.com/MKGitHub/JSONX.git then Drag & Drop the JSONX/Sources into your Xcode project.
• Manual: Drag & Drop the JSONX/Sources into your Xcode project.
• Carthage: In your Cartfile add github "MKGitHub/JSONX" ~> 1.1.0 then carthage update --no-build then Drag & Drop the JSONX/Sources into your Xcode project.
• Swift Package Manager (still quite meaningless): run swift build or swift package generate-xcodeproj
• CocoaPods (not recommended!): pod 'JSONX', '~> 1.1.0'

Documentation

Go to the documentation index page.

Used In Apps

JSONX is used in production in the following apps/games (known to me), these apps are together used by many millions of users every day. Please let me know if you use JSONX.

McDonald’s Sweden

Notes

https://github.com/MKGitHub/JSONX

http://www.xybernic.com

http://www.khanofsweden.com

Copyright 2016 Mohsan Khan

Licensed under the Apache License, Version 2.0.