An open API service indexing awesome lists of open source software.

https://github.com/putdotio/putio-swift

Swift SDK for interacting with the put.io API.
https://github.com/putdotio/putio-swift

Last synced: 4 months ago
JSON representation

Swift SDK for interacting with the put.io API.

Awesome Lists containing this project

README

          




putio-swift


Swift SDK for interacting with the put.io API.


Cocoapods
GitHub


## Installation

`PutioAPI` is available through [CocoaPods](https://cocoapods.org/pods/PutioAPI). To install, simply add the following line to your Podfile:

```ruby
pod 'PutioAPI'
```

## Usage

- For authentication, check the [Example Project](./Example/PutioAPI/ViewController.swift) for a simple [`ASWebAuthenticationSession`](https://developer.apple.com/documentation/authenticationservices/authenticating_a_user_through_a_web_service) flow.
- Check [the classes folder](./PutioAPI/Classes/) for available models and respective methods.
- You can also use `get`, `post`, `put`, and `delete` methods with relative URLs to make requests to the API.

## Contribution

Clone the repo.

```bash
git clone git@github.com:putdotio/putio-swift.git
cd ./putio-swift
```

Install the package managers, it's suggested to use `rbenv` and `bundler` for convenience.

```bash
gem install bundler # if you don't have bundler
bundle install
```

Install the dependencies then open the workspace.

```bash
cd ./Example
bundle exec pod install
open ./PutioAPI.xcworkspace
```