文件 • 社群論壇 • Stack Overflow • 回報錯誤 • 常見問題 • 支持
Result
類型的廣泛使用Codable
協定的強大功能輕鬆整合域模型Swift Package Manager 是一個用於管理 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 用戶端,只需將以下行新增至您的 Podfile 中:
pod 'AlgoliaSearchClient' , '~> 9.0.0'
# pod 'InstantSearchClient', '~> 7.0' // Swift 5.9 NOT YET RELEASED
然後,執行以下命令:
$ pod update
Carthage 是 Cocoa 的一個簡單的、去中心化的依賴管理器。
github "algolia/algoliasearch-client-swift" ~> 9.0 . 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 用戶端。
Swift API 用戶端與 Objective-C 相容,最高版本為 7.0.5。如果您正在處理 Objective-C 項目,請使用此版本的用戶端。
您可以透過以下方式之一將此程式庫與 Swift 一起使用:
pod 'AlgoliaSearch-Client-Swift', '~> 4.8.1'
pod 'AlgoliaSearch-Client-Swift', :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :branch => 'swift-3'
您可以透過以下方式之一將舊程式庫與 Swift 一起使用:
pod 'AlgoliaSearch-Client-Swift', '~> 8.19'
pod 'AlgoliaSearch-Client-Swift', :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :branch => 'swift-4'
遇到問題?在尋求支援之前,我們建議您先查看我們的常見問題解答,您可以在其中找到最常見問題和客戶遇到的問題的答案。您也可以開啟 GitHub 問題
此儲存庫託管為 Swift 產生的 Algolia API 用戶端的程式碼,如果您想做出貢獻,請前往主儲存庫。您也可以在我們的文件網站上找到貢獻指南。
Algolia Swift API 用戶端是一款根據 MIT 授權授權的開源軟體。