algoliasearch client swift

Идеальная отправная точка для интеграции Algolia в ваш проект Swift.

Документация • Форум сообщества • Stack Overflow • Сообщить об ошибке • Часто задаваемые вопросы • Поддержка

Функции

• Чистый кроссплатформенный клиент Swift.
• Типизированные запросы и ответы
• Широкое использование типа Result
• Использует возможности протокола Codable для простой интеграции моделей вашей предметной области.
• Потокобезопасные клиенты
• Подробное ведение журнала
• Инъекционный HTTP-клиент

Начиная

Менеджер пакетов Swift

Менеджер пакетов Swift — это инструмент для управления распространением кода Swift. Он интегрирован с системой сборки Swift для автоматизации процесса загрузки, компиляции и связывания зависимостей. С момента выпуска Swift 5 и Xcode 11 SPM совместим с системами сборки iOS, macOS и tvOS для создания приложений.

Чтобы использовать SwiftPM, вам следует использовать Xcode 11 для открытия своего проекта. Нажмите File -> Swift Packages -> Add Package Dependency , введите URL-адрес клиентского репозитория.

Если вы являетесь автором платформы и используете Swift API Client в качестве зависимости, обновите файл Package.swift :

 let package = Package (
    // 9.0.0 ..< 10.0.0
    dependencies : [
        . package ( url : " https://github.com/algolia/algoliasearch-client-swift " , from : " 9.0.0 " )
    ] ,
    // ...
)

Какаоподы

CocoaPods — это менеджер зависимостей для проектов Cocoa.

Чтобы установить клиент Algolia Swift, просто добавьте следующую строку в свой подфайл:

 pod 'AlgoliaSearchClient' , '~> 9.0.0'
# pod 'InstantSearchClient', '~> 7.0' // Swift 5.9 NOT YET RELEASED

Затем выполните следующую команду:

$ pod update

Карфаген

Carthage — простой децентрализованный менеджер зависимостей для Cocoa.

• Чтобы установить InstantSearch, просто добавьте следующую строку в свой Cartfile:

 github "algolia/algoliasearch-client-swift" ~> 9.0 . 0

• Запустите следующие команды из каталога проекта (для версии 8.0+)

carthage update
./Carthage/Checkouts/algoliasearch-client-swift/carthage-prebuild
carthage build

Если вы впервые используете Carthage в проекте, вам нужно будет выполнить некоторые дополнительные шаги, как описано в Carthage.

Теперь вы можете импортировать клиент Algolia API в свой проект и поиграть с ним.

Импортируйте пакет Core и необходимый клиентский пакет в файлы исходного кода:

 #if canImport(Core)
    import Core
#endif
import Search

let client = try SearchClient ( appID : " YOUR_APP_ID " , apiKey : " YOUR_API_KEY " )

// Add a new record to your Algolia index
let response = try await client . saveObject (
    indexName : " <YOUR_INDEX_NAME> " ,
    body : [ " objectID " : " id " , " test " : " val " ]
)

// Poll the task status to know when it has been indexed
try await client . waitForTask ( with : response . taskID , in : " <YOUR_INDEX_NAME> " )

// Fetch search results, with typo tolerance
let response : SearchResponses < Hit > = try await client
    . search ( searchMethodParams : SearchMethodParams ( requests : [ SearchQuery . searchForHits ( SearchForHits (
        query : " <YOUR_QUERY> " ,
        hitsPerPage : 50 ,
        indexName : " <YOUR_INDEX_NAME> "
    ) ) ] ) )

Для получения полной документации посетите Algolia Swift API Client .

Примечания

Поддержка Objective-C

Клиент Swift API совместим с Objective-C до версии 7.0.5. Используйте эту версию клиента, если вы работаете с проектом Objective-C.

Свифт 3

Вы можете использовать эту библиотеку со Swift одним из следующих способов:

• pod 'AlgoliaSearch-Client-Swift', '~> 4.8.1'
• pod 'AlgoliaSearch-Client-Swift', :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :branch => 'swift-3'

Свифт 4

Вы можете использовать старую библиотеку со Swift одним из следующих способов:

• pod 'AlgoliaSearch-Client-Swift', '~> 8.19'
• pod 'AlgoliaSearch-Client-Swift', :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :branch => 'swift-4'

❓ Устранение неполадок

Возникла проблема? Прежде чем обращаться в службу поддержки, мы рекомендуем зайти в раздел часто задаваемых вопросов, где вы найдете ответы на наиболее распространенные проблемы и затруднения с клиентом. Вы также можете открыть задачу на GitHub.

Содействие

В этом репозитории хранится код сгенерированного клиента Algolia API для Swift. Если вы хотите внести свой вклад, перейдите в основной репозиторий. Вы также можете найти руководства по участию на нашем веб-сайте документации.

? Лицензия

Клиент Algolia Swift API — это программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT.