Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kgn/jsonmagic
JSONMagic makes it easy to traverse and parse JSON in Swift.
https://github.com/kgn/jsonmagic
carthage cocoapods json swift
Last synced: about 1 month ago
JSON representation
JSONMagic makes it easy to traverse and parse JSON in Swift.
- Host: GitHub
- URL: https://github.com/kgn/jsonmagic
- Owner: kgn
- License: mit
- Created: 2016-02-18T08:01:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-16T00:43:14.000Z (almost 8 years ago)
- Last Synced: 2024-10-13T07:03:06.929Z (about 1 month ago)
- Topics: carthage, cocoapods, json, swift
- Language: Swift
- Size: 33.2 KB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSONMagic
`JSONMagic` makes it easy to traverse and parse JSON in Swift.
[]()
[](/releases)
[](/LICENSE)
[](https://travis-ci.org/kgn/JSONMagic)
[]()
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/JSONMagic)
[](https://cocoapods.org/pods/JSONMagic)
[](http://twitter.com/iamkgn)
[](https://github.com/kgn)
[](https://github.com/kgn/JSONMagic)
## Installing
### Carthage
```
github "kgn/JSONMagic"
```
### CocoaPods
```
pod 'JSONMagic'
```
## Examples
Lets say you get a JSON user profile like this from your server:
``` json
{
"user": {
"name": "David Keegan",
"age": 30,
"accounts": [
{
"name": "twitter",
"user": "iamkgn"
},
{
"name": "dribbble",
"user": "kgn"
},
{
"name": "github",
"user": "kgn"
}
]
}
}
```
Parsing this can take a bunch of nested if statements in Swift to cast things to the right type in order to traverse down the data tree.
### Before
``` Swift
let twitterUser: String?
if let data = serverResponse {
if let json = try? NSJSONSerialization.JSONObjectWithData(data, options: []) as? [String: Any] {
if let user = json?["user"] as? [String: Any] {
if let accounts = user["accounts"] as? [Any] {
if let twitter = accounts.first as? [String: Any] {
twitterUser = twitter["user"] as? String
}
}
}
}
}
```
### After
``` Swift
let twitterUser = JSONMagic(data: serverResponse).get("user").get("accounts").first.get("user").string
```
Or, if you prefer subscripting :)
``` Swift
let twitterUser = JSONMagic(data: serverResponse)["user"]["accounts"][0]["user"].string
```
It even works with [Paw](https://paw.cloud) key paths.
``` Swift
let twitterUser = JSONMagic(data: serverResponse).keypath("user.accounts.0.user").string
```
`JSONMagic` handles all of this for you with method chaining. So you’re always working with a magical wrapper `JSONMagic` object that you can chain as long as you want, then just call `value` at the end to get the ending value and cast that to the final type you want. There are helpers for all the JSON data types too: `.bool`, `.int`, `.float`, `.double`, `.string`, `.array` and `.dictionary`.
It’s super *loosie goosie* so doesn’t care about `nil` values going in, or anywhere in the chain.
### Some more examples
``` Swift
let json = JSONMagic(data: serverResponse)
json.get("user").get("name").string // David Keegan
json["user"]["age"].integer // 30
let twitter = json.get("user").get("accounts").first
twitter["name"].value // twitter
twitter["user"].value // iamkgn
let dribbble = json.get("user").get("accounts").get(1)
dribbble.get("name").value // dribbble
dribbble.get("user").value // kgn
let github = json.get("user").get("accounts").last
github.get("name").value // github
github.get("user").value // kgn
let bad = json.get("user").get("accounts").get(5)
bad.get("name").value // nil
bad.get("user").value // nil
```
## Progress
- [X] Badges
- [X] Tests
- [X] Travis
- [X] Carthage
- [X] CocoaPods
- [X] Description
- [X] Documentation
- [X] AppleTV
- [X] AppleWatch
- [X] Prebuilt Frameworks
- [ ] Travis Test Matrix