Algolia Swift SDK

Unofficial Algolia Swift SDK built by Algolia employee. Adopts the latest Swift features and provides the best developer experience.

• Pure Swift SDK
• Implements the Algolia retry strategy for network requests
• Covered by official Algolia API clients test suite
• Adopts the modern Swift concurrency
• Uses Combine for state mangement
• Uses the result builder for search and settings parameters
• Provides convenient wait() methods for asynchronous backend tasks

Contents

• Algolia Search client - library that allows developers to interact with Algolia's search and indexing API using Swift. The library provides a set of APIs and tools for performing various search and indexing operations on Algolia indices, as well as support for advanced search features such as faceting and geo-search. It offers a strongly typed API and built-in error handling and response parsing capabilities, making it easy to create fast and relevant search experiences for users.

• Algolia Insights client - API client for the Insights requests which lets you capture click, conversion, and view events to help you understand how your users interact with your search and discovery experience.

• Algolia Filters - library that provides building blocks for creating and combining filters for Algolia Search. It offers a convenient, strongly typed API for modifying and updating the state of filters. The library ensures that the resulting filter expression is always valid and can be used as a search parameter.

Install

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To use SwiftPM, you should use Xcode 11 to open your project. Click File -> Swift Packages -> Add Package Dependency, enter github.com/VladislavFitz/algolia-swift-sdk

If you're a framework author and use Swift API Client as a dependency, update your Package.swift file:

let package = Package(
    dependencies: [
        .package(url: "https://github.com/VladislavFitz/algolia-swift-sdk", from: "0.3.0")
    ],
    // ...
)