Modern apps interact with a lot of different APIs. Netable makes that easier by providing a simple interface for using those APIs to drive high quality iOS and MacOS apps, built on Swift Codable
, while still supporting non-standard and unusual APIs when need be.
Features
Netable's core philosophy is to ensure that developers can write simple code for simple APIs, while providing various options for wrangling strange or non-standard APIs.
- Every request is an independent type
- Facilitates breaking up requests into separate files, avoiding monolithic networking classes
Codable
-basedResult
return types- Easy interfacing between model and controller layers
- Reduces need for wrapper types
- Can automatically convert request responses into usable objects
- Easily integrates with existing logging libraries, or logs to
debugPrint
by default - Comprehensive error types make handling expected and unexpected errors painless
Usage
Standard Usage
Netable
, and pass in your base URL:
Make a new instance of let netable = Netable(baseURL: URL(string: "https://api.thecatapi.com/v1/")!)
Request
Extend struct CatImage: Decodable {
let id: String
let url: String
}
struct GetCatImages: Request {
typealias Parameters = [String: String]
typealias RawResource = [CatImage]
public var method: HTTPMethod { return .get }
public var path: String {
return "images/search"
}
public var parameters: [String: String] {
return ["mime_type": "jpg,png", "limit": "2"]
}
}
Make your request and handle the result:
netable.request(GetCatImages()) { result in
switch result {
case .success(let catImages):
if let firstCat = catImages.first,
let url = URL(string: firstCat.url),
let imageData = try? Data(contentsOf: url) {
self.catsImageView1.image = UIImage(data: imageData)
}
if let lastCat = catImages.last,
let url = URL(string: lastCat.url),
let imageData = try? Data(contentsOf: url) {
self.catsImageView2.image = UIImage(data: imageData)
}
case .failure(let error):
let alert = UIAlertController(
title: "Uh oh!",
message: "Get cats request failed with error: \(error)",
preferredStyle: .alert
)
alert.addAction(UIAlertAction(title: "OK", style: .cancel))
self.present(alert, animated: true, completion: nil)
}
}
Resource Extraction
Have your request object handle extracting a usable object from the raw resource
struct CatImage: Decodable {
let id: String
let url: String
}
struct GetCatImageURL: Request {
typealias Parameters = [String: String]
typealias RawResource = [CatImage]
typealias FinalResource = URL
// ...
func finalize(raw: RawResource) -> Result<FinalResource, NetableError> {
guard let catImage = raw.first else {
return .failure(NetableError.resourceExtractionError("The CatImage array is empty"))
}
guard let url = URL(string: catImage.url) else {
return .failure(NetableError.resourceExtractionError("Could not build URL from CatImage url string"))
}
return .success(url)
}
}
Leave your network code to deal with the important stuff
netable.request(GetCatImageURL()) { result in
switch result {
case .success(let catUrl):
guard let imageData = try? Data(contentsOf: catUrl) else {
return
}
self.imageView.image = UIImage(data: imageData)
case .failure(let error):
// ...
}
}
Full Documentation
In-depth documentation is provided through Jazzy and GitHub Pages.
Example
To run the example project, clone the repo, and run pod install
from inside the Example directory first.
Requirements
- iOS 10.0+
- MacOS 10.15+
- Xcode 11.0+
Installation
Netable is available through Swift Package Manager. To install it, follow these steps:
- In Xcode, click File, then Swift Package Manager, then Add Package Dependency
- Choose your project
- Enter this URL in the search bar
https://github.com/steamclock/netable.git
Netable is also available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'Netable'
Then run pod install
.
License
Netable is available under the MIT license. See the License.md for more info.