About ApiKit

ApiKit is a Swift SDK that helps you integrate with any REST API.

ApiKit defines an ApiClient protocol that describes how to request raw and typed data from any REST API. The protocol is implemented by URLSession, so you can use the shared session without having to create a client.

ApiKit defines ApiEnvironment & ApiRoute protocols that make it easy to model API environments and routes, as well as an ApiRequest that can define a route and response type for even easier use.

Installation

ApiKit can be installed with the Swift Package Manager:

https://github.com/danielsaidi/ApiKit.git

Getting Started

Consider that you want to integrate with the Yelp API, which can return restaurants, reviews, etc.

You would first define the various API environments you want to integrate with. In this case, let's just integrate with the v3 environment, which requires an API header token for all requests:

import ApiKit

enum YelpEnvironment: ApiEnvironment {

    case v3(apiToken: String)
    
    var url: String {
        switch self {
        case .v3: "https://api.yelp.com/v3/"
        }
    }
 
    var headers: [String: String]? {
        switch self {
        case .v3(let token): ["Authorization": "Bearer \(token)"]
        }
    }
}

We can then define the routes to request from the Yelp API. In this case, let's just fetch a business by ID:

import ApiKit

enum YelpRoute: ApiRoute {

    case business(id: String)

    var path: String {
        switch self {
        case .business(let id): "businesses/\(id)"
        }
    }

    var httpMethod: HttpMethod { .get }
    var headers: [String: String]? { nil }
    var formParams: [String: String]? { nil }
    var postData: Data? { nil }
    
    var queryParams: [String: String]? {
        switch self {
        case .business: nil
        }
    }
}

With the environment and route in place, we can fetch a YelpBusiness with any ApiClient or URLSession:

let client = URLSession.shared
let environment = YelpEnvironment.v3(apiToken: "YOUR_TOKEN")
let route = YelpRoute.business(id: "abc123") 
let business: YelpBusiness = try await client.request(route, in: environment)

The generic request functions will automatically map the raw response to the requested type, and throw any raw errors that occur. There are also non-generic variants if you want to get the raw data or use custom error handling.

See the online getting started guide for more information.

Documentation

The online documentation has more information, articles, code examples, etc.

Demo Application

The Demo folder has an app that lets you explore the library and integrate with a few APIs.

Support my work

You can sponsor me on GitHub Sponsors or reach out for paid support, to help support my open-source projects.

Your support makes it possible for me to put more work into these projects and make them the best they can be.

Contact

Feel free to reach out if you have questions or want to contribute in any way:

• Website: danielsaidi.com
• Mastodon: @danielsaidi@mastodon.social
• Twitter: @danielsaidi
• E-mail: daniel.saidi@gmail.com

License

ApiKit is available under the MIT license. See the LICENSE file for more info.