Swiftpack.co - Package - contentful/contentful.swift

header

Join Contentful Community Slack   Join Contentful Community Forum

contentful.swift - Swift Delivery SDK for Contentful

Swift SDK for the Contentful Content Delivery API and Content Preview API. It helps you to easily access your Content stored in Contentful with your Swift applications.

This repository is actively maintained   MIT License   Build Status   Coverage Status   Codebeat badge

Version   Carthage compatible   Swift Package Manager compatible   iOS | macOS | watchOS | tvOS  

What is Contentful?

Contentful provides content infrastructure for digital teams to power websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship their products faster.

Table of contents

Core Features

Getting started

In order to get started with the Contentful Swift SDK you'll need not only to install it, but also to get credentials which will allow you to have access to your content in Contentful.

Installation

CocoaPods installation
platform :ios, '9.0'
use_frameworks!
pod 'Contentful'

You can specify a specific version of Contentful depending on your needs. To learn more about operators for dependency versioning within a Podfile, see the CocoaPods doc on the Podfile.

pod 'Contentful', '~> 3.1.2' 

Carthage installation

You can also use Carthage for integration by adding the following to your Cartfile:

github "contentful/contentful.swift" ~> 3.1.2

Swift Package Manager [swift-tools-version 4.2]

Add the following line to your array of dependencies:

.package(url: "https://github.com/contentful/contentful.swift", .upToNextMajor(from: "3.1.2"))

Your first request

The following code snippet is the most basic one you can use to fetch content from Contentful with this SDK:

import Contentful
import Interstellar // A lightweight Functional Reactive Programming dependency.

let client = Client(spaceId: "cfexampleapi",
                    environmentId: "master", // Defaults to "master" if omitted.
                    accessToken: "b4c0n73n7fu1")

client.fetchEntry(id: "nyancat") { (result: Result<Entry>) in
    switch result {
        case .success(let entry):
            print(entry)
        case .error(let error):
            print("Error \(error)!")
    }
}

Accessing the Preview API

To access the Content Preview API, use your preview access token and set your client configuration to use preview as shown below.


let client = Client(spaceId: "cfexampleapi",
                    accessToken: "e5e8d4c5c122cf28fc1af3ff77d28bef78a3952957f15067bbc29f2f0dde0b50",
                    host: Host.preview) // Defaults to Host.delivery if omitted.

Authorization

Grab credentials for your Contentful space by navigating to the "APIs" section of the Contentful Web App. If you don't have access tokens for your app, create a new set for the Delivery and Preview APIs. Next, pass the id of your space and delivery access token into the initializer like so:

Map Contentful entries to Swift classes via EntryDecodable

The EntryDecodable protocol allows you to define a mapping between your content types and your Swift classes that entries will be serialized to. When using methods such as:

let query = QueryOn<Cat>.where(field: .color, .equals("gray"))

client.fetchMappedEntries(matching: query) { (result: Result<MappedArrayResponse<Cat>>) in
    guard let cats = result.value?.items else { return }
    print(cats)
}

The asynchronously returned result will be an instance of MappedArrayResponse in which the generic type parameter is the class you've defined for your content type. If you are using a Query that does not restrict the response to contain entries of one content type, you will use methods that return MixedMappedArrayResponse instead of MappedArrayResponse. The EntryDecodable protocol extends the Decodable protocol in Swift 4's Foundation standard library. The SDK provides helper methods for resolving relationships between EntryDecodables and also for grabbing values from the fields container in the JSON for each resource.

In the example above, Cat is a type of our own definition conforming to EntryDecodable and EntryQueryable. In order for the SDK to properly create your model types when receiving JSON, you must pass in these types to your Client instance:

let contentTypeClasses: [EntryDecodable.Type] = [
    Cat.self
    Dog.self,
    Human.self
]

let client = Client(spaceId: spaceId,
                    accessToken: deliveryAPIAccessToken,
                    contentTypeClasses: contentTypeClasses)

The source for the Cat model class is below; note the helper methods the SDK adds to Swift 4's Decoder type to simplify for parsing JSON returned by Contentful. You also need to pass in these types to your Client instance in order to use the fetch methods which take EntryDecodable type references:

final class Cat: EntryDecodable, EntryQueryable {

    static let contentTypeId: String = "cat"

    let sys: Sys
    let color: String?
    let name: String?
    let lives: Int?
    let likes: [String]?

    // Relationship fields.
    var bestFriend: Cat?

    public required init(from decoder: Decoder) throws {
        sys             = try decoder.sys()
        let fields      = try decoder.contentfulFieldsContainer(keyedBy: Cat.Fields.self)

        self.name       = try fields.decodeIfPresent(String.self, forKey: .name)
        self.color      = try fields.decodeIfPresent(String.self, forKey: .color)
        self.likes      = try fields.decodeIfPresent(Array<String>.self, forKey: .likes)
        self.lives      = try fields.decodeIfPresent(Int.self, forKey: .lives)

        try fields.resolveLink(forKey: .bestFriend, decoder: decoder) { [weak self] linkedCat in
            self?.bestFriend = linkedCat as? Cat
        }
    }

    enum Fields: String, CodingKey {
        case bestFriend
        case name, color, likes, lives
    }
}

Documentation & References

Reference Documentation

The SDK has 100% documentation coverage of all public variables, types, and functions. You can view the docs on the web or browse them in Xcode. For further information about the Content Delivery API, check out the Content Delivery API Reference Documentation.

Tutorials & other resources

  • This library is a wrapper around our Contentful Delivery REST API. Some more specific details such as search parameters and pagination are better explained on the REST API reference, and you can also get a better understanding of how the requests look under the hood.
  • Check the Contentful for Swift page for Tutorials, Demo Apps, and more information on other ways of using Swift with Contentful

Swift playground

If you'd like to try an interactive demo of the API via a Swift Playground, do the following:

git clone --recursive https://github.com/contentful/contentful.swift.git
cd contentful.swift
make open

Then build the "Contentful_macOS" scheme, open the playground file and go! Note: make sure the "Render Documentation" button is switched on in the Utilities menu on the right of Xcode, and also open up the console to see the outputs of the calls to print.

Example application

See the Swift iOS app on Github and follow the instructions on the README to get a copy of the space so you can see how changing content in Contentful affects the presentation of the app.

Migration

We gathered all information related to migrating from older versions of the library in our Migrations.md document.

Swift Versioning

It is recommended to use Swift 4.1, as older versions of the SDK will not have fixes backported. If you must use older Swift versions, see the compatible tags below.

Swift version | Compatible Contentful tag | | --- | --- | | Swift 4.1 | [ ≥ 2.0.0] | Swift 4.0 | [0.10.0 - 1.0.1] | | Swift 3.x | [0.3.0 - 0.9.3] | | Swift 2.3 | 0.2.3 | | Swift 2.2 | 0.2.1 |

Reach out to us

You have questions about how to use this library?

  • Reach out to our community forum: Contentful Community Forum
  • Jump into our community slack channel: Contentful Community Slack

You found a bug or want to propose a feature?

  • File an issue here on GitHub: File an issue. Make sure to remove any credential from your code before sharing it.

You need to share confidential information or have other questions?

  • File a support ticket at our Contentful Customer Support: File support ticket

Get involved

PRs Welcome

We appreciate any help on our repositories. For more details about how to contribute see our Contributing.md document.

License

This repository is published under the MIT license.

Code of Conduct

We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.

Read our full Code of Conduct.

Github

link
Stars: 59
Help us keep the lights on

Dependencies

Releases

3.1.2 - Aug 24, 2018

Fixed

A retain cycle due to the fact that the URLSession owned by Client was not invalidated on client deallocation. Thanks to @edwardmp for identifying the issue and submitting a fix in #226.

3.1.1 - Aug 21, 2018

Fixed

  • A critical bug that caused the fetchLocales(then:) method to not pass the correct error back to it's completion handler. This bug would, for example, incorrectly pass back an SDKError if internet connection dropped rather than passing back the proper NSErrror from Foundation.

3.1.0 - Aug 10, 2018

Added

  • Query and QueryOn methods for finding entries which reference another entry (by id) with a specific linking field.

3.0.0 - Jul 30, 2018

See the guide for migrating from 2.x to 3.x of contentful.swift

Added

  • BREAKING: PNGs can now be retrieved with .standard or .eight bits as an additional ImageOption to request PNGs from the Images API.

Fixed

  • Now all error responses from the API will fallback to seraializing an SDKError if the SDK is unable to serialize an APIError

Changed

  • BREAKING: Configuring a Client to interface with Content Preview API is no longer done through the ClientConfiguration type. Instead, pass host: Host.preview to the Client initializer. Also, you can now configure the client to use any arbitrary string host if you have whitelisted via your plan in Contentful.

2.2.1 - Jul 29, 2018

Fixed

  • Accessing fields on assets was not respecting fallback chain logic when assets were requested with a multi-locale format. This is now fixed.