Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nixzhu/baby
Create models from a JSON file, even a Baby can do it.
https://github.com/nixzhu/baby
code-generator json model parser parser-combinators swift
Last synced: 4 days ago
JSON representation
Create models from a JSON file, even a Baby can do it.
- Host: GitHub
- URL: https://github.com/nixzhu/baby
- Owner: nixzhu
- License: mit
- Created: 2017-04-18T02:06:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-18T02:37:57.000Z (almost 3 years ago)
- Last Synced: 2024-10-15T23:02:40.457Z (about 1 month ago)
- Topics: code-generator, json, model, parser, parser-combinators, swift
- Language: Swift
- Homepage: https://apps.apple.com/cn/app/ducky-model-editor/id1525505933
- Size: 111 KB
- Stars: 222
- Watchers: 9
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Baby
Create models from a JSON file, even a Baby can do it.
## Description
Baby can infer property's type from json such as `String`, `Int`, `Double`, `URL` and `Date`.
Baby can handle nested json, it will generate nested models.
Baby supports `Codable` from Swift 4.
### Example
JSON:
``` json
{
"id": 42,
"name": "nixzhu",
"twitter": {
"profile_url": "https://twitter.com/nixzhu",
"created_at": "2009-05-12T10:25:43.511Z"
}
}
```
Swift code with `Codable`:
``` swift
struct User: Codable {
let id: Int
let name: String
struct Twitter: Codable {
let profileURL: URL
let createdAt: Date
private enum CodingKeys: String, CodingKey {
case profileURL = "profile_url"
case createdAt = "created_at"
}
}
let twitter: Twitter
}
```
Note that there use **Property Map** `profile_url: profileURL` to change the property name (Automatically generated will be `profileUrl`).
Swift code without `Codable`:
``` swift
struct User {
let id: Int
let name: String
struct Twitter {
let profileURL: URL
let createdAt: Date
init(profileURL: URL, createdAt: Date) {
self.profileURL = profileURL
self.createdAt = createdAt
}
init?(json: [String: Any]) {
guard let profileURLString = json["profile_url"] as? String else { return nil }
guard let profileURL = URL(string: profileURLString) else { return nil }
guard let createdAtString = json["created_at"] as? String else { return nil }
guard let createdAt = DateFormatter.iso8601.date(from: createdAtString) else { return nil }
self.init(profileURL: profileURL, createdAt: createdAt)
}
}
let twitter: Twitter
init(id: Int, name: String, twitter: Twitter) {
self.id = id
self.name = name
self.twitter = twitter
}
init?(json: [String: Any]) {
guard let id = json["id"] as? Int else { return nil }
guard let name = json["name"] as? String else { return nil }
guard let twitterJSONDictionary = json["twitter"] as? [String: Any] else { return nil }
guard let twitter = Twitter(json: twitterJSONDictionary) else { return nil }
self.init(id: id, name: name, twitter: twitter)
}
}
```
You may need a `DateFormatter` extension:
``` swift
extension DateFormatter {
static let iso8601: DateFormatter = {
let formatter = DateFormatter()
formatter.timeZone = TimeZone(abbreviation: "UTC")
formatter.locale = Locale(identifier: "en_US_POSIX")
formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ"
return formatter
}()
}
```
Baby can also handle array root json, it will automatically merge properties for objects in array.
## Installation
### Build
```bash
$ bash install.sh
```
### Run
``` bash
$ baby -i JSONFilePath
```
### Help
``` bash
$ baby --help
```
Try Baby's web interface [SharedBaby](https://github.com/nixzhu/SharedBaby) if you like.
Get [Ducky](https://apps.apple.com/cn/app/ducky-model-editor/id1525505933) in the Mac App Store.
## Contact
You can find me on [Twitter](https://twitter.com/nixzhu).
## License
MIT