https://github.com/yutomizutani/jsontocodable
A generating tool from Raw JSON to Codable (Swift4) text written in Swift4.
https://github.com/yutomizutani/jsontocodable
codable converter generator json swift swift4
Last synced: 11 months ago
JSON representation
A generating tool from Raw JSON to Codable (Swift4) text written in Swift4.
- Host: GitHub
- URL: https://github.com/yutomizutani/jsontocodable
- Owner: YutoMizutani
- License: mit
- Created: 2018-09-20T10:43:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-17T03:32:45.000Z (over 7 years ago)
- Last Synced: 2025-06-14T13:03:12.629Z (about 1 year ago)
- Topics: codable, converter, generator, json, swift, swift4
- Language: Swift
- Size: 5.07 MB
- Stars: 37
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.bitrise.io/app/869daca1801a29aa)
[](https://github.com/YutoMizutani/JSONtoCodable)
[](https://github.com/YutoMizutani/JSONtoCodable/blob/master/LICENSE)
[](https://github.com/YutoMizutani/JSONtoCodable)
[](https://github.com/YutoMizutani/JSONtoCodable)
[](https://codecov.io/gh/YutoMizutani/JSONtoCodable)
**JSONtoCodable** is a generating tool from Raw JSON to Codable (Swift4) text written in Swift4.
Qiita: [JSONからCodable化されたstructを自動生成するツールを作った話 - Qiita](https://qiita.com/YutoMizutani/items/106cae55091f26bba641)
## TL;DR
From JSON,
```json
{
"user": {
"Name": "Yuto Mizutani"
},
"lib": {
"lib-name": "JSONtoCodable",
"year": 2018,
"version": "1.0.2",
"released": "2018-09-22"
},
"text": "Hello, world!!"
}
```
to Codable.
```swift
public struct Result: Codable {
public let user: User
public let lib: Lib
public let text: String
public struct User: Codable {
public let name: String
private enum CodingKeys: String, CodingKey {
case name = "Name"
}
}
public struct Lib: Codable {
public let libName: String
public let year: Int
public let version: String
public let released: String
private enum CodingKeys: String, CodingKey {
case libName = "lib-name"
case year
case version
case released
}
}
}
```
## [JaCo (macOS App)](https://github.com/YutoMizutani/JSONtoCodable/tree/master/Apps/JaCo)
## [jc (CLI App)](https://github.com/YutoMizutani/JSONtoCodable/tree/master/Apps/jc)
### Installation
```
$ brew tap YutoMizutani/jc
$ brew install jc
```
### Usage example
```
$ curl https://httpbin.org/get | jc
```
or generate *.swift* file,
```
$ curl https://httpbin.org/get | jc > Result.swift
```
### Help command
```
$ jc -h
```
### Screen shot
## Support formats
- Type
- String
- Bool
- Int
- Double
- struct(s)
- Optional
- Array
- Start array
- Muptiple array
- Arrayed objects
- Optional array
- Number of nested array and objects
- Infinity
- Number of spaces in entered JSON
- 0 to infinity
## Translations
|JSON Value|Swift Type|
|:-:|:-:|
|"text"|String|
|true|Bool|
|-10|Int|
|1.0|Double|
|null|\?|
|(the others)|Any|
## Usage
```swift
import JSONtoCodable
let json: String = """
{
"Hello": "Hello, world!!"
}
"""
let jsonToCodable = JSONtoCodable()
let codable = try? jsonToCodable.generate(json)
print(codable)
/*
struct Result: Codable {
let hello: String
private enum CodingKeys: String, CodingKey {
case hello = "Hello"
}
}
*/
```
## Config
```swift
let config = Config()
config.name = "Result" // struct Result: Codable {}
config.accessModifier = AccessModifier.public // public struct
config.caseType = (variable: CaseType.camel, struct: CaseType.pascal)
config.lineType = LineType.lineFeed
config.indentType = IndentType.space(4)
```
[See more: Config.swift](https://github.com/YutoMizutani/JSONtoCodable/blob/master/Sources/Core/Config.swift)
## Installation
#### Cocoapods
Add this to your Podfile:
```
pod 'JSONtoCodable'
```
and
```
$ pod install
```
#### Carthage
Add this to your Cartfile:
```
github "YutoMizutani/JSONtoCodable"
```
and
```
$ carthage update
```
## License
JSONtoCodable is available under the [MIT license](https://github.com/YutoMizutani/JSONtoCodable/blob/master/LICENSE).