Latest release is redesigned for Swift 2. See the release note for migration guide.

APIKit

APIKit is a library for building type-safe web API client in Swift.

Parameters of a request are validated by type-system.
Type of a response is inferred from the type of its request.
A result of a request is represented by Result<Value, Error>, which is also known as Either.
All the endpoints can be enumerated in nested class.

let request = GitHub.SearchRepositories(query: "APIKit", sort: .Stars)

GitHub.sendRequest(request) { result in
    switch result {
    case .Success(let response):
        self.repositories = response // inferred as [Repository]
        self.tableView.reloadData()

    case .Failure(let error):
        print(error)
    }
}

Requirements

Swift 2
iOS 8.0 or later
Mac OS 10.9 or later

If you want to use APIKit with Swift 1.2, try 0.8.2.

Installation

Carthage

Insert github "ishkawa/APIKit" to your Cartfile.
Run carthage update.
Link your app with APIKit.framework and Result.framework in Carthage/Checkouts.

CocoaPods

Insert pod "APIKit" to your Podfile.
Run pod install.

Usage

Create a request protocol that inherits Request protocol.
Add baseURL property in an extension of request protocol.
Create an API class that inherits API class.
Define request types that conform to request protocol in API class.
1. Create a type that represents a request of the web API.
2. Assign type that represents a response object to Response typealiase.
3. Add method and path variables.
4. Implement buildResponseFromObject(_:URLResponse:) to build Response from a raw object, which may be an array or a dictionary.

protocol GitHubRequest: Request {

}

extension GitHubRequest {
    var baseURL: NSURL {
        return NSURL(string: "https://api.github.com")!
    }
}

class GitHubAPI: API {
    struct GetRateLimit: GitHubRequest {
        typealias Response = RateLimit

        var method: HTTPMethod {
            return .GET
        }

        var path: String {
            return "/rate_limit"
        }

        func responseFromObject(object: AnyObject, URLResponse: NSHTTPURLResponse) -> Response? {
            guard let dictionary = object as? [String: AnyObject] else {
                return nil
            }

            guard let rateLimit = RateLimit(dictionary: dictionary) else {
                return nil
            }

            return rateLimit
        }
    }
}

struct RateLimit {
    let count: Int
    let resetDate: NSDate

    init?(dictionary: [String: AnyObject]) {
        guard let count = dictionary["rate"]?["limit"] as? Int else {
            return nil
        }

        guard let resetDateString = dictionary["rate"]?["reset"] as? NSTimeInterval else {
            return nil
        }

        self.count = count
        self.resetDate = NSDate(timeIntervalSince1970: resetDateString)
    }
}

Sending request

let request = GitHubAPI.GetRateLimit()

GitHubAPI.sendRequest(request) { result in
    switch result {
    case .Success(let rateLimit):
        print("count: \(rateLimit.count)")
        print("resetDate: \(rateLimit.resetDate)")

    case .Failure(let error):
        print("error: \(error)")
    }
}

Canceling request

GitHub.cancelRequest(GitHubAPI.GetRateLimit.self)

If you want to filter requests to be cancelled, add closure that identifies the request should be cancelled or not.

GitHub.cancelRequest(GitHubAPI.SearchRepositories.self) { request in
    return request.query == "APIKit"
}

Configuring request

APIKit uses following 4 properties in Request when build NSURLRequest.

var baseURL: NSURL
var method: HTTPMethod
var path: String
var parameters: [String: AnyObject]

parameters will be converted into query parameter if method is one of .GET, .HEAD and .DELETE. Otherwise, it will be serialized by requestBodyBuilder and set to HTTPBody of NSURLRequest.

Configuring format of HTTP body

APIKit uses requestBodyBuilder when it serialize parameter into HTTP body of a request, and it uses responseBodyParser when it deserialize an object from HTTP body of a response. Default format of the body of request and response is JSON.

var requestBodyBuilder: RequestBodyBuilder
var responseBodyParser: ResponseBodyParser

You can specify the format of HTTP body implement this property.

var requestBodyBuilder: RequestBodyBuilder {
    return .URL(encoding: NSUTF8StringEncoding)
}

Configuring manually

func configureURLRequest(URLRequest: NSMutableURLRequest) throws -> NSMutableURLRequest {
    // You can add any configurations here
}

Configuring response

Setting acceptable status code

APIKit decides if a request is succeeded or failed by using acceptableStatusCodes:. If it contains the status code of a response, the request is judged as succeeded and API calls responseFromObject(_:URLResponse:) to get a model from a raw response. Otherwise, the request is judged as failed and API calls errorFromObject(_:URLResponse:) to get an error from a raw response.

var acceptableStatusCodes: Set<Int> {
    return Set(200..<300)
}

Building a model from a response

func responseFromObject(object: AnyObject, URLResponse: NSHTTPURLResponse) -> Response? {
    guard let dictionary = object as? [String: AnyObject] else {
        return nil
    }

    guard let rateLimit = RateLimit(dictionary: dictionary) else {
        return nil
    }

    return rateLimit
}

Building an error from a response

For example, GitHub API returns an error like this:

{
    "message": "Validation Failed"
}

To create error that contains message in response, implement errorFromObject(_:URLResponse:) and return ErrorType using object.

func errorFromObject(object: AnyObject, URLResponse: NSHTTPURLResponse) -> ErrorType? {
    guard let dictionary = object as? [String: AnyObject] else {
        return nil
    }

    guard let message = dictionary["message"] as? String else {
        return nil
    }

    return GitHubError(message: message)
}

Practical Example

Authorization

class GitHubAPI: API {
    static var accessToken: String?
}

protocol GitHubRequest: Request {
    var authenticate: Bool { get }
}

extension GitHubRequest {
    var baseURL: NSURL {
        return NSURL(string: "https://api.github.com")!
    }

    var authenticate: Bool {
        return true
    }

    func configureURLRequest(URLRequest: NSMutableURLRequest) throws -> NSMutableURLRequest {
        if authenticate {
            guard let accessToken = GitHubAPI.accessToken else {
                throw APIKitError.CannotBuildURLRequest
            }

            URLRequest.setValue("token \(accessToken)", forHTTPHeaderField: "Authorization")
        }

        return URLRequest
    }
}

Pagination

let request = SomeAPI.SomePaginatedRequest(page: 1)

SomeAPI.sendRequest(request) { result in
    switch result {
    case .Success(let response):
        print("results: \(response.results)")
        print("nextPage: \(response.nextPage)")
        print("hasNext: \(response.hasNext)")

    case .Failure(let error):
        print("error: \(error)")
    }
}

struct PaginatedResponse<T> {
    var results: Array<T>
    var nextPage: Int { get }
    var hasNext: Bool { get }

    init(results: Array<T>, URLResponse: NSHTTPURLResponse) {
        self.results = results
        self.nextPage = /* get nextPage from `Link` field of URLResponse */
        self.hasNext = /* get hasNext from `Link` field of URLResponse */
    }
}

struct SomePaginatedRequest: Request {
    typealias Response = PaginatedResponse<Some>

    var method: HTTPMethod {
        return .GET
    }

    var path: String {
        return "/paginated"
    }

    let page: Int

    static func responseFromObject(object: AnyObject, URLResponse: NSHTTPURLResponse) -> Response? {
        guard let dictionaries = object as? [[String: AnyObject]] else {
            return nil
        }

        var somes = [Some]()
        for dictionary in dictionaries {
            if let some = Some(dictionary: dictionary) {
                somes.append()
            }
        }

        return PaginatedResponse(results: somes, URLResponse: URLResponse)
    }
}

Advanced usage

NSURLSessionDelegate

You can add custom behaviors of NSURLSession by following steps:

Create a subclass of URLSessionDelegate (e.g. MyAPIURLSessionDelegate).
Implement additional delegate methods in it.
Override defaultURLSession of API and return NSURLSession that has MyURLSessionDelegate as its delegate.

This can add following features:

Hook events of NSURLSession
Handle authentication challenges
Convert a data task to NSURLSessionDownloadTask

NOTE: URLSessionDelegate also implements delegate methods of NSURLSession to implement wrapper of NSURLSession, so you should call super if you override following methods.

func URLSession(_:task:didCompleteWithError:)
func URLSession(_:dataTask:didReceiveData:)
func URLSession(_:dataTask:didBecomeDownloadTask:)

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

wpsteak / apikit Goto Github PK

apikit's Introduction