Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 1.64 KB

README.md

File metadata and controls

58 lines (41 loc) · 1.64 KB
Raw

Formula 1 API

This Swift library provides endpoint access to Formula 1 data provided by the Ergast API. By using this library, you won't have to build the interactive layer yourself, and can just start consuming the data.

Installing / Getting started

Formula 1 API supports Swift Package Manager. To use SwiftPM, you should use the most recent version of Xcode to add this project.

Click File -> Swift Packages -> Add Package Dependency, enter Formula1API repo's URL. Or you can login Xcode with your GitHub account and just type Formula1API to search.

Features

Formula1API provides functions that allow you to access endpoints for data.

Currently, you can fetch:

  • Circuits (all, specified season)
  • Seasons
  • Constructors (all, specified season)
  • Race Schedule (specified season)
  • Race Results (specified season)
  • Qualifying Results (specified season),
  • Pit Stops (specified season),
  • Laps(specified season)

More endpoints will be accessible as development progresses.

Usage

Usage of this library within your app or package is simple.

Access endpoints via the Formula1API object.

Return closure example:

Formula1API.constructors(for: .year(2022)) { result in
    switch result {
    case .success(let constructors):
        print(constructors)
    case .failure(let error):
        print(error)
    }
}

Async-await example:

do {
    let constructors = try await Formula1API.constructors(for: .year(2022))
} catch error {
    print(error)
}

Licensing

The code in this project is licensed under MIT license.