magic-mapper-swift
- Finish writing
README.md - Ability to map
NSManagedObject - Ability to convert model back to dictionary
How to setup
Step 1: Get the JSON model
{
"total_count": 176552,
"incomplete_results": false,
"items": [
{...}
]
}
Step 2: Write the Swift models
class GithubRepository: NSObject, Mappable {
var id : String = ""
var name : String = ""
var body : String = ""
var url : String = ""
var photo : String = ""
var createdAt : Date?
}
class GithubSearch: NSObject, Mappable {
var total : Int = 0
var items : [GithubRepository] = []
}
Step 3: Link your custom namings with the JSON model
The mapFromDictionary property lets you customize the properties mappings. You can also access nested values within dictionaries and arrays (example: emails.0.address).
var mapFromDictionary: [String : String] {
return [
"body" : "description",
"photo" : "owner.avatar_url",
"createdAt" : "created_at"
]
}
Step 4: Custom properties
The mapFromDictionaryTypes property let's you customize the type of the JSON property (only for optionals). If you have other Swift structures that you need to use, just extend them using the Mappable protocol.
var mapFromDictionaryTypes: [String : Mappable.Type] {
return [
"createdAt" : Date.self
]
}
For instance createdAt is of type Date and the JSON property is of type String. In order to convert the String to a Date type, just extend it using the Mappable protocol and it will automatically know to convert and set the value to the model.
extension Date: Mappable {
init?(from: Any) {
if let value = from as? String {
let formatter = DateFormatter()
formatter.dateFormat = "YYYY-MM-dd'T'HH':'mm':'ss'Z'"
if let date = formatter.date(from: value) {
self.init(timeIntervalSince1970: date.timeIntervalSince1970)
return
}
}
self.init()
}
}
And that's it!
You can now populate your model from the generic dictionary that comes from your network layer. Happy coding :)
Alamofire.request(APIURL).responseJSON { (response) in
if let dictionary = response.result.value as? KeyValue {
self.feed = GithubSearch(dictionary)
}
}
Contributing
There's still work to do here! Our goal is to speed up development times, making JSON mapping easy as 1-2-3. We would love to see you involved in this project!
43 Dec 15, 2022
3.5k Dec 20, 2022
21.7k Jan 3, 2023
2k Dec 31, 2022
249 Jun 29, 2022
11.3k Dec 31, 2022
21 Aug 1, 2022
964 Dec 14, 2022
611 Oct 23, 2022
10 Sep 29, 2021
454 Oct 30, 2022
4.1k Dec 29, 2022
9k Jan 2, 2023
4.7k Dec 30, 2022
27 Aug 26, 2022
31 Nov 22, 2021
8 Nov 22, 2022
0 Oct 29, 2021
43 Dec 15, 2022