文档 • 社区论坛 • 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 许可证授权的开源软件。