Pexels API client library for the Swift programming language.

Last update: Sep 1, 2022

Overview

Pexels-Swift

Pexels.com API client library for the Swift programming language.

Overview

This Swift Package is a wrapper for Pexels API to get access to the entire photo library of Pexels within your Swift app.

It is mandatory to get an API Key.

Installation (SPM)

dependencies: [
  .package(url: "https://github.com/lukepistrol/Pexels-Swift.git", from: "0.1.0")
],

Documentation

See the full documentation here or build it locally using ⇧⌃⌘D in Xcode once you added Pexels-Swift to your project.

Usage

import PexelsSwift

// access the singleton instance
let pexels = PexelsSwift.shared

// set your API key
pexels.setup(apiKey: "YOUR_API_KEY", logLevel: .debug)

// fetch images metadata using async/await
let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (data, paging, response)):
    // access photos
    // data -> [PSPhoto]
    // paging -> PSPagingInfo
    // response -> HTTPURLResponse
}

// fetch images metadata using completion handlers
pexels.getCuratedPhotos() { result in
    switch result {
    case .failure(let error):
        print(error.description)
    case .success(let (data, paging, response)):
        // access photos
        // data -> [PSPhoto]
        // paging -> PSPagingInfo
        // response -> HTTPURLResponse
    }
}

Demo Project

I've built a simple iOS app - PexelsBrowser - using this library and SwiftUI.

A Swift library for Discord REST/Gateway API in all platforms.

swift-discord main develop A Swift library for Discord API. Package Products Discord, alias library that contains DiscordREST, DiscordGateway. Discord

3 Sep 30, 2022

Cross-platform Swift library for accessing the public GitHub API.

GoatHerb GoatHerb is a cross-platform Swift library for accessing the GitHub API. Features General Compatible with swift-log. Full concurrency (async/

3 Oct 30, 2022

🐦 An asynchronous Twitter library based on the Twitter v2 API

Twift Twift is an asynchronous Swift library for the Twitter v2 API. No external dependencies Only one callback-based method (requestUserCredentials)

91 Jan 1, 2023

The template for Delta Client plugins.

Delta Plugin Template This repository is a template for Delta Client plugins. To create a plugin, create a repo from this template repo and then repla

1 Jan 12, 2022

A simple Hacker News mobile client

A simple Hacker News mobile client. Overview This app was built with the Hacker News API This is one of my first apps outside of a tut

0 Nov 29, 2021

An ultra-lightweight native Discord client for vintage and modern Mac OS

Discord Lite An ultra-lightweight native Discord client for vintage and modern Mac OS Minimum System Requirements Mac OS X version 10.4 (Tiger) PowerP

155 Jan 2, 2023

hackfoldr client for iOS

hackfoldr-iOS This is a simple iOS client for hackfoldr Why? Hackfoldr on mobile is simply not good enough on iOS. Use CocoaPods developer CocoaPods i

24 Feb 10, 2022

A Hacker News client written in React Native

React Native Hacker News A modern cross-platform HackerNews client built on React Native Features The app currently has the following functionality: H

65 Dec 14, 2022

Beam: the open source Reddit client for iOS

Beam for Reddit An open source Reddit client for iOS. Introduction Hi, we're Awkward. In 2014, we started working on a Reddit client called Beam. In t

250 Dec 30, 2022

Comments

refactor: added HTTPURLResponse to returned result tuple

Before

let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (data, paging)):
    // access photos
    // data -> [PSPhoto]
    // paging -> PSPagingInfo
}

After

let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (data, paging, response)):
    // access photos
    // data -> [PSPhoto]
    // paging -> PSPagingInfo
    // response -> HTTPURLResponse
}

enhancement

opened by lukepistrol 0

Releases(0.9.4)

0.9.4(Oct 5, 2022)
added PSLoggerDelegate to enable log injection in existing logging infrastructure

Source code(tar.gz)
Source code(zip)

0.9.3(Jun 22, 2022)

0.9.3

added support for tvOS and watchOS

0.9.2

fixed per_page coding key typo. Thanks to @SugiKent

0.9.1

added rate limit tracking. See Rate Limits for more information.

0.9.0

Breaking Changes:

added HTTPURLResponse to results tuple:

let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (data, paging, response)):
    // access photos
    // data -> [PSPhoto]
    // paging -> PSPagingInfo
    // response -> HTTPURLResponse
}

Source code(tar.gz)
Source code(zip)

0.9.2(May 29, 2022)

0.9.2

fixed per_page coding key typo. Thanks to @SugiKent

0.9.1

added rate limit tracking. See Rate Limits for more information.

0.9.0

Breaking Changes:

added HTTPURLResponse to results tuple:

let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (data, paging, response)):
    // access photos
    // data -> [PSPhoto]
    // paging -> PSPagingInfo
    // response -> HTTPURLResponse
}

Source code(tar.gz)
Source code(zip)

0.9.1(May 23, 2022)

0.9.1

added rate limit tracking. See Rate Limits for more information.

0.9.0

Breaking Changes:

added HTTPURLResponse to results tuple:

let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (data, paging, response)):
    // access photos
    // data -> [PSPhoto]
    // paging -> PSPagingInfo
    // response -> HTTPURLResponse
}

Source code(tar.gz)
Source code(zip)

0.9.0(May 23, 2022)

Breaking Changes:

added HTTPURLResponse to results tuple:

let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (data, paging, response)):
    // access photos
    // data -> [PSPhoto]
    // paging -> PSPagingInfo
    // response -> HTTPURLResponse
}

Source code(tar.gz)
Source code(zip)

0.8.2(May 20, 2022)
0.8.2

renamed PSMetaData to PSPagingInfo

0.8.1

added Getting Started Guide to documentation.

0.8.0

Breaking Changes:

added PSMetaData to results for queries that use paging (page, next page, previous page,…)

let result = await pexels.getCuratedPhotos() switch result { case .failure(let error): print(error.description) case .success(let (photos, metadata)): // access photos and metadata }
Source code(tar.gz)
Source code(zip)
0.8.1(May 19, 2022)
0.8.1

added Getting Started Guide to documentation.

0.8.0

Breaking Changes:

added PSMetaData to results for queries that use paging (page, next page, previous page,…)

let result = await pexels.getCuratedPhotos() switch result { case .failure(let error): print(error.description) case .success(let (photos, metadata)): // access photos and metadata }
Source code(tar.gz)
Source code(zip)

0.8.0(May 19, 2022)

Breaking Changes:

added PSMetaData to results for queries that use paging (page, next page, previous page,…)

let result = await pexels.getCuratedPhotos()

switch result {
case .failure(let error):
    print(error.description)
case .success(let (photos, metadata)):
    // access photos and metadata
}

Source code(tar.gz)
Source code(zip)

0.7.4(May 19, 2022)
0.7.4

added PSLogger.log(_ message:) method

updated documentation

Previous Changes

0.7.3

updated documentation

0.7.2

added backwards compatibility for iOS 13.0 and macOS 10.15

0.7.1

updated DocC documentation

0.7.0

Breaking Changes:

renamed external parameter: result: to count: in searchVideos()

New Features:

added localization: parameter to searchPhotos() and searchVideos()

Internal Changes:

enhanced API endpoint URL generation

moved parameter string literals to QueryParameter enum

updated folder structure

added shadow types CategoryID, ErrorDescription

updated documentation

Source code(tar.gz)
Source code(zip)
0.7.3(May 19, 2022)
0.7.3

updated documentation

0.7.2

added backwards compatibility for iOS 13.0 and macOS 10.15

0.7.1

updated DocC documentation

0.7.0

Breaking Changes:

renamed external parameter: result: to count: in searchVideos()

New Features:

added localization: parameter to searchPhotos() and searchVideos()

Internal Changes:

enhanced API endpoint URL generation

moved parameter string literals to QueryParameter enum

updated folder structure

added shadow types CategoryID, ErrorDescription

updated documentation

Source code(tar.gz)
Source code(zip)
0.7.2(May 16, 2022)
0.7.2

added backwards compatibility for iOS 13.0 and macOS 10.15

0.7.1

updated DocC documentation

0.7.0

Breaking Changes:

renamed external parameter: result: to count: in searchVideos()

New Features:

added localization: parameter to searchPhotos() and searchVideos()

Internal Changes:

enhanced API endpoint URL generation

moved parameter string literals to QueryParameter enum

updated folder structure

added shadow types CategoryID, ErrorDescription

updated documentation

Source code(tar.gz)
Source code(zip)
0.7.1(May 16, 2022)
0.7.1

updated DocC documentation

0.7.0

Breaking Changes:

renamed external parameter: result: to count: in searchVideos()

New Features:

added localization: parameter to searchPhotos() and searchVideos()

Internal Changes:

enhanced API endpoint URL generation

moved parameter string literals to QueryParameter enum

updated folder structure

added shadow types CategoryID, ErrorDescription

updated documentation

Source code(tar.gz)
Source code(zip)
0.7.0(May 16, 2022)
Breaking Changes:

renamed external parameter: result: to count: in searchVideos()

New Features:

added localization: parameter to searchPhotos() and searchVideos()

Internal Changes:

enhanced API endpoint URL generation

moved parameter string literals to QueryParameter enum

updated folder structure

added shadow types CategoryID, ErrorDescription

updated documentation

Source code(tar.gz)
Source code(zip)

0.6.0(May 16, 2022)

New Features:

added closure versions of get methods:

// fetch images metadata using completion handlers
pexels.getCuratedPhotos() { result in
    switch result {
    case .failure(let error):
        print(error.description)
    case .success(let photos):
        // access photos
    }
}

Internal Changes:

moved methods for Photos, Videos, Collections to their own separate files
disabled logging in tests
updated docs

Source code(tar.gz)
Source code(zip)

0.5.0(May 15, 2022)
Breaking Changes:

renamed setAPIKey(_:) to setup(apiKey:logLevel:)

// access the singleton instance let pexels = PexelsSwift.shared // set your API key pexels.setup(apiKey: "YOUR_API_KEY", logLevel: .debug)

New Features:

added PSLogger for logging events to the console on runtime.

see Ratelimit statistics in logs.

see fetched data as JSON in logs.

see errors in logs.

Internal Changes:

refactored fetch methods

Source code(tar.gz)
Source code(zip)
0.4.1(May 14, 2022)
0.4.1

updated docs

0.4.0

Breaking Changes:

renamed PSCollectionCategory to PSCollection

renamed getCategories() to getCollections()

results now get returned in a Result<T, Error> format:

let result = await pexels.getCuratedPhotos() switch result { case .failure(let error): // handle error case .success(let photos): // access photos }

Internal changes:

using async/await syntax for URLSession instead of Combine

renamed enum PSURL to API

Source code(tar.gz)
Source code(zip)
0.4.0(May 14, 2022)
Breaking Changes:

renamed PSCollectionCategory to PSCollection

renamed getCategories() to getCollections()

results now get returned in a Result<T, Error> format:

let result = await pexels.getCuratedPhotos() switch result { case .failure(let error): // handle error case .success(let photos): // access photos }

Internal changes:

using async/await syntax for URLSession instead of Combine

renamed enum PSURL to API

Source code(tar.gz)
Source code(zip)
0.3.0(May 13, 2022)

Breaking: renamed getPhotos(search:) to searchPhotos(_:)

Added videos endpoints
Source code(tar.gz)
Source code(zip)
0.2.2(May 13, 2022)

updated documentation
Source code(tar.gz)
Source code(zip)
0.2.1(May 13, 2022)

added documentation
Source code(tar.gz)
Source code(zip)
0.2.0(May 13, 2022)

Breaking: renamed module to PexelsSwift.

New: added query for a single photo based on id.
Source code(tar.gz)
Source code(zip)
0.1.0(May 12, 2022)

Source code(tar.gz)
Source code(zip)

Owner

Lukas Pistrol

Swift frontend developer. Currently working on @CodeEditApp

GitHub

Pexels API client library for the Swift programming language.

Related tags

Overview

Pexels-Swift

Overview

Installation (SPM)

Documentation

Usage

Demo Project

You might also like...

A Swift library for Discord REST/Gateway API in all platforms.

Cross-platform Swift library for accessing the public GitHub API.

🐦 An asynchronous Twitter library based on the Twitter v2 API

The template for Delta Client plugins.

A simple Hacker News mobile client

An ultra-lightweight native Discord client for vintage and modern Mac OS

hackfoldr client for iOS

A Hacker News client written in React Native

Beam: the open source Reddit client for iOS

Comments

refactor: added HTTPURLResponse to returned result tuple

Before

After

Releases(0.9.4)

0.9.4(Oct 5, 2022)

0.9.3(Jun 22, 2022)

0.9.3

0.9.2

0.9.1

0.9.0

Breaking Changes:

0.9.2(May 29, 2022)

0.9.2

0.9.1

0.9.0

Breaking Changes:

0.9.1(May 23, 2022)

0.9.1

0.9.0

Breaking Changes:

0.9.0(May 23, 2022)

Breaking Changes:

0.8.2(May 20, 2022)

0.8.2

0.8.1

0.8.0

Breaking Changes:

0.8.1(May 19, 2022)

0.8.1

0.8.0

Breaking Changes:

0.8.0(May 19, 2022)

Breaking Changes:

0.7.4(May 19, 2022)

0.7.4

Previous Changes

0.7.3

0.7.2

0.7.1

0.7.0

Breaking Changes:

New Features:

Internal Changes:

0.7.3(May 19, 2022)

0.7.3

0.7.2

0.7.1

0.7.0

Breaking Changes:

New Features:

Internal Changes:

0.7.2(May 16, 2022)

0.7.2

0.7.1

0.7.0

Breaking Changes:

New Features:

Internal Changes:

0.7.1(May 16, 2022)

0.7.1