Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Restofire/Restofire
Restofire is a protocol oriented networking client for Alamofire
https://github.com/Restofire/Restofire
alamofire carthage cocoapods moya networking protocol-oriented protocol-oriented-programming restofire swift urlsession xcode
Last synced: about 1 month ago
JSON representation
Restofire is a protocol oriented networking client for Alamofire
- Host: GitHub
- URL: https://github.com/Restofire/Restofire
- Owner: Restofire
- License: mit
- Archived: true
- Created: 2015-10-25T16:08:52.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2022-04-28T22:05:42.000Z (over 2 years ago)
- Last Synced: 2024-07-26T11:26:47.786Z (about 2 months ago)
- Topics: alamofire, carthage, cocoapods, moya, networking, protocol-oriented, protocol-oriented-programming, restofire, swift, urlsession, xcode
- Language: Swift
- Homepage: https://restofire.github.io/Restofire/
- Size: 2.71 MB
- Stars: 380
- Watchers: 10
- Forks: 26
- Open Issues: 6
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ios - Restofire - Restofire is a protocol oriented network abstraction layer in swift that is built on top of Alamofire to use services in a declartive way. (Networking / Video)
- awesome-ios-star - Restofire - Restofire is a protocol oriented network abstraction layer in swift that is built on top of Alamofire to use services in a declartive way. (Networking / Video)
- Awesome-Swift-Packages - Restofire - Restofire is a protocol oriented networking client for Alamofire https://restofire.github.io/Restofire/ (Network)
README
## 
[](https://cocoapods.org/pods/Restofire)
[](https://raw.githubusercontent.com/Restofire/Restofire/master/LICENSE)
[](https://github.com/apple/swift-package-manager)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/Restofire)
[](https://travis-ci.org/Restofire/Restofire/branches)
[](https://gitter.im/Restofire/Restofire?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://twitter.com/rahulkatariya91)
Restofire is a protocol oriented networking client for [Alamofire](https://github.com/Alamofire/Alamofire).
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Features
- [x] Global Configuration for host / headers / parameters etc
- [x] Group Configurations
- [x] Per Request Configuration
- [x] Authentication
- [x] Response Validations
- [x] Custom Response Serializers like JSONDecodable
- [x] Isolate Network Requests from ViewControllers
- [x] Auto retry based on URLError codes
- [x] Request eventually when network is reachable
- [x] NSOperations
## Requirements
- iOS 10.0+ / Mac OS X 10.12+ / tvOS 10.0+ / watchOS 3.0+
- Xcode 10
## Installation
### Dependency Managers
CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate Restofire into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!
pod 'Restofire', '~> 5.0'
```
Then, run the following command:
```bash
$ pod install
```
Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate Restofire into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "Restofire/Restofire" ~> 5.0
```
Swift Package Manager
To use Restofire as a [Swift Package Manager](https://swift.org/package-manager/) package just add the following in your Package.swift file.
```swift
import PackageDescription
let package = Package(
name: "HelloRestofire",
dependencies: [
.Package(url: "https://github.com/Restofire/Restofire.git", from: "5.0.0")
]
)
```
### Manually
If you prefer not to use either of the aforementioned dependency managers, you can integrate Restofire into your project manually.
Git Submodules
- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
```bash
$ git init
```
- Add Restofire as a git [submodule](http://git-scm.com/docs/git-submodule) by running the following command:
```bash
$ git submodule add https://github.com/Restofire/Restofire.git
$ git submodule update --init --recursive
```
- Open the new `Restofire` folder, and drag the `Restofire.xcodeproj` into the Project Navigator of your application's Xcode project.
> It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.
- Select the `Restofire.xcodeproj` in the Project Navigator and verify the deployment target matches that of your application target.
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
- In the tab bar at the top of that window, open the "General" panel.
- Click on the `+` button under the "Embedded Binaries" section.
- You will see two different `Restofire.xcodeproj` folders each with two different versions of the `Restofire.framework` nested inside a `Products` folder.
> It does not matter which `Products` folder you choose from.
- Select the `Restofire.framework` & `Alamofire.framework`.
- And that's it!
> The `Restofire.framework` is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.
Embeded Binaries
- Download the latest release from https://github.com/Restofire/Restofire/releases
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
- In the tab bar at the top of that window, open the "General" panel.
- Click on the `+` button under the "Embedded Binaries" section.
- Add the downloaded `Restofire.framework` & `Alamofire.framework`.
- And that's it!
### Configurations
#### Three levels of configuration
- **Global Configuration** – The global configuration will be applied to all the requests. These include values like scheme, host, version, headers, sessionManager, callbackQueue, maxRetryCount, waitsForConnectivity etc.
```swift
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
Restofire.Configuration.default.host = "httpbin.org"
Restofire.Retry.default.retryErrorCodes = [.requestTimedOut,.networkConnectionLost]
return true
}
```
- **Group Configuration** – The group configuration inherits all the values from the global configuration. It can be used to group requests that have same behaviour but are different from the global configuration. For instance, If you have more than one host or if your global configuration has default url session and some requests require you to use ephemeral URL session.
```swift
import Restofire
protocol ApiaryConfigurable: Configurable {}
extension ApiaryConfigurable {
public var configuration: Configuration {
var configuration = Configuration.default
configuration.host = "private-07c21-rahulkatariya.apiary-mock.com"
configuration.headers = ["Content-Type": "application/json"]
return configuration
}
}
protocol ApiaryRequestable: Requestable, ApiaryConfigurable {}
import Restofire
struct NoteResponseModel: Decodable {
var id: Int16
var title: String
}
struct NotesGETService: ApiaryRequestable {
typealias Response = [NoteResponseModel]
var path: String? = "notes"
}
```
- **Per Request Configuration** – The request configuration inherits all the values from the group configuration or directly from the global configuration.
```swift
import Restofire
struct NoteRequestModel: Encodable {
var title: String
}
struct NotePOSTService: Requestable {
typealias Response = NoteResponseModel
let host: String = "private-07c21-rahulkatariya.apiary-mock.com"
let headers = ["Content-Type": "application/json"]
let path: String? = "notes"
let method: HTTPMethod = .post
var parameters: Any?
init(parameters: NoteRequestModel) {
let data = try! JSONEncoder().encode(parameters)
self.parameters = try! JSONSerialization.jsonObject(with: data, options: .allowFragments)
}
}
```
## Usage
### Making a Request
`Requestable` gives completion handler to enable making requests and receive response.
```swift
import Restofire
class ViewController: UITableViewController {
var notes: [NoteResponseModel]!
var requestOp: RequestOperation!
override func viewDidLoad() {
super.viewDidLoad()
// We want to cancel the request to save resources when the user pops the view controller.
requestOp = NotesGetAllService().execute() {
if let value = $0.result.value {
self.notes = value
}
}
}
func postNote(title: String) {
let noteRequestModel = NoteRequestModel(title: title)
// We don't want to cancel the request even if user pops the view controller.
NotePOSTService(parameters: noteRequestModel).execute()
}
deinit {
requestOp.cancel()
}
}
```
### Isolating Network Requests from UIViewControllers
`Requestable` gives delegate methods to enable making requests from anywhere which you can use to store data in your cache.
```swift
import Restofire
struct NotesGetAllService: ApiaryRequestable {
...
func request(_ request: RequestOperation, didCompleteWithValue value: [NoteResponseModel]) {
// Here you can store the results into your cache and then listen for changes inside your view controller.
}
}
```
### Custom Response Serializers
- **Decodable**
By adding the following snippet in your project, All `Requestable` associatedType Response as `Decodable` will be decoded with JSONDecoder.
```swift
import Restofire
extension Restofire.DataResponseSerializable where Response: Decodable {
public var responseSerializer: DataResponseSerializer {
return DataRequest.JSONDecodableResponseSerializer()
}
}
```
- **JSON**
By adding the following snippet in your project, All `Requestable` associatedType Response as `Any` will be decoded with NSJSONSerialization.
```swift
import Restofire
extension Restofire.DataResponseSerializable where Response == Any {
public var responseSerializer: DataResponseSerializer {
return DataRequest.jsonResponseSerializer()
}
}
```
### Wait for Internet Connectivity
`Requestable` gives you a property waitsForConnectivity which can be set to true. This will make the first request regardless of the internet connectivity. If the request fails due to .notConnectedToInternet, it will retry the request when internet connection is established.
```swift
struct PushTokenPutService: Requestable {
typealias Response = Data
...
var waitsForConnectivity: Bool = true
}
```
# Contributing
Issues and pull requests are welcome!
# Author
Rahul Katariya [@rahulkatariya91](https://twitter.com/rahulkatariya91)
## License
Restofire is released under the MIT license. See [LICENSE](https://github.com/Restofire/Restofire/blob/master/LICENSE) for details.