Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/otbivnoe/codablealamofire
An extension for Alamofire that converts JSON data into Decodable objects.
https://github.com/otbivnoe/codablealamofire
alamofire ios json mapping parsing-library swfit swift4
Last synced: about 2 months ago
JSON representation
An extension for Alamofire that converts JSON data into Decodable objects.
- Host: GitHub
- URL: https://github.com/otbivnoe/codablealamofire
- Owner: Otbivnoe
- License: mit
- Archived: true
- Created: 2017-06-10T12:54:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-20T18:36:14.000Z (about 3 years ago)
- Last Synced: 2024-09-28T22:02:40.358Z (about 2 months ago)
- Topics: alamofire, ios, json, mapping, parsing-library, swfit, swift4
- Language: Swift
- Homepage:
- Size: 110 KB
- Stars: 740
- Watchers: 18
- Forks: 55
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/Otbivnoe/CodableAlamofire)
[](https://github.com/apple/swift-package-manager)
[](https://github.com/Carthage/Carthage)
[](http://cocoadocs.org/docsets/CodableAlamofire)
**Swift 4 introduces a new `Codable` protocol that lets you serialize and deserialize custom data types without writing any special code and without having to worry about losing your value types. 🎉**
**Awesome, isn't it? And this library helps you write less code! It's an extension for `Alamofire` that converts `JSON` data into `Decodable` object.**
### Useful Resources:
- [Encoding and Decoding Custom Types](https://developer.apple.com/documentation/foundation/archives_and_serialization/encoding_and_decoding_custom_types) - Article by Apple
- [Using JSON with Custom Types](https://developer.apple.com/documentation/foundation/archives_and_serialization/using_json_with_custom_types) - Swift Playground
- Also there is a special session from `WWDC2017` that covers this new feature - [What's New in Foundation](https://developer.apple.com/videos/play/wwdc2017/212/)
# Usage
Let's decode a simple json file:
```
{
"result": {
"libraries": [
{
"name": "Alamofire",
"stars": 23857,
"url": "https://github.com/Alamofire/Alamofire",
"random_date_commit": 1489276800
},
{
"name": "RxSwift",
"stars": 9600,
"url": "https://github.com/ReactiveX/RxSwift",
"random_date_commit": 1494547200
}
]
}
}
```
with the following Swift model:
```swift
private struct Repo: Decodable {
let name: String
let stars: Int
let url: URL
let randomDateCommit: Date
private enum CodingKeys: String, CodingKey {
case name
case stars
case url
case randomDateCommit = "random_date_commit"
}
}
```
There is a similar method to `responseData`, `responseJSON` - **`responseDecodableObject`**:
```swift
func responseDecodableObject(queue: DispatchQueue? = nil, keyPath: String? = nil, decoder: JSONDecoder = JSONDecoder(), completionHandler: @escaping (AFDataResponse) -> Void)
```
- `queue` - The queue on which the completion handler is dispatched.
- `keyPath` - The keyPath where object decoding should be performed.
- `decoder` - The decoder that performs the decoding of JSON into semantic `Decodable` type.
```swift
let url = URL(string: "https://raw.githubusercontent.com/otbivnoe/CodableAlamofire/master/keypathArray.json")!
let decoder = JSONDecoder()
decoder.dateDecodingStrategy = .secondsSince1970 // It is necessary for correct decoding. Timestamp -> Date.
AF.request(url).responseDecodableObject(keyPath: "result.libraries", decoder: decoder) { (response: AFDataResponse<[Repo]>) in
let repo = response.value
print(repo)
}
```
### Note:
- For array: `DataResponse<[Repo]>`
- For single object: `DataResponse`
# Requirements
- Swift 4+
- Xcode 9+
# Installation 🔥
## CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Swift and Objective-C Cocoa projects. It has over eighteen thousand libraries and can help you scale your projects elegantly. You can install it with the following command:
```bash
$ sudo gem install cocoapods
```
To integrate CodableAlamofire, simply add the following line to your `Podfile`:
```ruby
target 'Test' do
use_frameworks!
pod 'CodableAlamofire'
end
```
## Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate CodableAlamofire into your Xcode project using Carthage, specify it in your `Cartfile`:
```odgl
github "Otbivnoe/CodableAlamofire"
```
Run `carthage update` to build the framework and drag the built `CodableAlamofire.framework` into your Xcode project.