https://github.com/nixzhu/ananda
JSON model decoding based on yyjson.
https://github.com/nixzhu/ananda
json macro swift
Last synced: 5 months ago
JSON representation
JSON model decoding based on yyjson.
- Host: GitHub
- URL: https://github.com/nixzhu/ananda
- Owner: nixzhu
- License: mit
- Created: 2023-01-11T11:38:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T03:48:08.000Z (over 1 year ago)
- Last Synced: 2024-10-29T23:38:42.557Z (over 1 year ago)
- Topics: json, macro, swift
- Language: Swift
- Homepage:
- Size: 2.92 MB
- Stars: 77
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://swiftpackageindex.com/nixzhu/Ananda)
[](https://swiftpackageindex.com/nixzhu/Ananda)
# Ananda
JSON model decoding based on [yyjson](https://github.com/ibireme/yyjson).
## Example
Consider the following JSON:
```json
{
"profile": {
"nickname": "NIX",
"username": "@nixzhu@mastodon.social",
"avatar": {
"url": "https://example.com/nixzhu.png",
"width": 200,
"height": 200
}
},
"toots": [
{
"id": 1,
"content": "Hello World!",
"created_at": "2024-10-05T09:41:00.789Z"
},
{
"id": 2,
"content": "How do you do?",
"created_at": "2025-04-29T22:23:24.567Z"
}
]
}
```
We can create models conforming to the `AnandaModel` protocol as follows:
```swift
import Foundation
import Ananda
struct Mastodon: AnandaModel {
let profile: Profile
let toots: [Toot]
init(json: AnandaJSON) {
profile = .decode(from: json.profile)
toots = json.toots.array().map { .decode(from: $0) }
}
}
extension Mastodon {
struct Profile: AnandaModel {
let nickname: String
let username: String
let avatar: Avatar
init(json: AnandaJSON) {
nickname = json.nickname.string()
username = json.username.string()
avatar = .decode(from: json.avatar)
}
}
}
extension Mastodon.Profile {
struct Avatar: AnandaModel {
let url: URL
let width: Double
let height: Double
init(json: AnandaJSON) {
url = json["url"].url()
width = json.width.double()
height = json.height.double()
}
}
}
extension Mastodon {
struct Toot: AnandaModel {
let id: Int
let content: String
let createdAt: Date
init(json: AnandaJSON) {
id = json.id.int()
content = json.content.string()
createdAt = json.created_at.date()
}
}
}
```
To decode a `Mastodon` instance from a JSON string:
```swift
let mastodon = Mastodon.decode(from: jsonString)
```
Or, if you already have JSON data:
```swift
let mastodon = Mastodon.decode(from: jsonData)
```
To decode a specific JSON branch, for example `profile.avatar`, specify its path:
```swift
let avatar = Mastodon.Profile.Avatar.decode(from: jsonData, path: ["profile", "avatar"])
```
To decode an array (e.g., `toots`):
```swift
let toots = [Mastodon.Toot].decode(from: jsonData, path: ["toots"])
```
Or decode only the first toot:
```swift
let toot = Mastodon.Toot.decode(from: jsonData, path: ["toots", 0])
```
## Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
Once you have a Swift package set up, add Ananda as a dependency in your `Package.swift` file:
```swift
// In Package.swift
dependencies: [
.package(url: "https://github.com/nixzhu/Ananda.git", from: "1.2.0"),
]
```
Typically, you will want to depend on the `Ananda` product:
```swift
// In a target's dependencies
.product(name: "Ananda", package: "Ananda")
```
## Swift Macro
With [AnandaMacros](https://github.com/nixzhu/AnandaMacros), you can use macros to eliminate the need for initialization methods, as shown below:
```swift
import Foundation
import Ananda
import AnandaMacros
@AnandaInit
struct Mastodon: AnandaModel {
let profile: Profile
let toots: [Toot]
}
extension Mastodon {
@AnandaInit
struct Profile: AnandaModel {
let nickname: String
let username: String
let avatar: Avatar
}
}
extension Mastodon.Profile {
@AnandaInit
struct Avatar: AnandaModel {
let url: URL
let width: Double
let height: Double
}
}
extension Mastodon {
@AnandaInit
struct Toot: AnandaModel {
let id: Int
let content: String
@AnandaKey("created_at")
let createdAt: Date
}
}
```
Simple and clean, right?
## Benchmark
See [AnandaBenchmark](https://github.com/nixzhu/AnandaBenchmark).
## Tool
You can use [Ducky Model Editor](https://apps.apple.com/us/app/ducky-model-editor/id1525505933) to generate AnandaModel from JSON, saving you time.
