Framework

SwAuth

Easily send OAuth 2.0 authorized HTTP requests with async/await in Swift.

Overview

SwAuth provides an easy way to send OAuth 2.0 HTTP requests for Swift applications. It’s built on SwiftNIO and utilizes Swift’s new and intuitive async/await syntax. The library supports OAuth 2.0’s: Authorization Code Flow with AuthorizationCodeFlow, it’s more secure extension, Proof Key for Code Exchange with PKCEAuthorizationFlow, and the extension for when a browser interface is impractical, the Device Authorization Grant through the DeviceAuthorizationFlow!

Topics

Essential

Choosing the Right Authorization Flow
SwAuth provides 3 different OAuth 2.0 authorization flows to use: AuthorizationCodeFlow, PKCEAuthorizationFlow, and DeviceAuthorizationFlow. Choosing which one to use and in what context can be difficult.
protocol Swauthable
All of the authorization flows (AuthorizationCodeFlow, PKCEAuthorizationFlow, DeviceAuthorizationFlow) conform to this protocol.

The Authorization Flows

class AuthorizationCodeFlow
The OAuth 2.0 Authorization Code Grant according to RFC 6749/6750.
class PKCEAuthorizationFlow
The Proof Key for Code Exchange (PKCE) extension to the OAuth 2.0 Authorization Code Grant according to RFC 7636.
class DeviceAuthorizationFlow
The Device Authorization Grant extension to the OAuth 2.0 Authorization Code Grant according to to RFC 8628.

Built-in Support

class Spotify
Spotify’s Web API.

Request and Response

Use HTTPRequest to build a request, send the request with authenticatedRequest(for:numberOfRetries:), and get a HTTPRequest.Response.
struct HTTPRequest
HTTP load request.
func authenticatedRequest(for: HTTPRequest, numberOfRetries: UInt8) async throws -> HTTPRequest.Response
Sends an authenticated HTTP request to a Web API endpoint. Returns a HTTPRequest.Response.
struct Response
The response from a authenticatedRequest(for:numberOfRetries:).

Errors

enum SwAuthError
SwAuthError is the error type that is thrown by methods in this library.

Protocols

protocol JSONSubscriptType
protocol Response
A response to be handled by a authorizationResponseHandler(for:).

Structures

struct JSON
struct Tokens
The tokens from a token request.

Operators

func == (JSON, JSON) -> Bool
func < (JSON, JSON) -> Bool
func > (JSON, JSON) -> Bool
func <= (JSON, JSON) -> Bool
func >= (JSON, JSON) -> Bool

Type Aliases

typealias JSONIndex
typealias JSONRawIndex

Enumerations

enum Index
enum JSONKey
To mark both String and Int can be used in subscript.
enum RequestBodyEncoding
Enumeration of possible encodings of a HTTP request body.
enum SwiftyJSONError
enum Type
JSON’s type definitions.
enum writingOptionsKeys