文档 • 社区论坛 • Stack Overflow • 报告错误 • 支持

✨特性

• Swift 客户端与 Swift 5 及更高版本兼容。
• 它依赖于开源 Swift 库，以便无缝集成到 Swift 项目中
  • SwiftLog.
• 与 Algolia API 的异步和同步交互方法
• 线程安全客户端
• 类型请求和响应
• 可注入 HTTP 客户端

安装

Swift 5.0+

1. 添加 InstantSearchClient 依赖
   • CocoaPods
     • 将 pod 'AlgoliaSearchClientSwift', '~> 8.0.0-beta.4' 添加到您的 Podfile 中。
   • Carthage
     • 将 github "algolia/algoliasearch-client-swift" ~> 8.0.0-beta.4 添加到您的 Cartfile 中。
     • 在项目目录中运行以下命令

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

   • Swift 包管理器
     • 在 Package.swift 中的包依赖项数组中添加 .package(name: "AlgoliaSearchClientSwift", url: "https://github.com/algolia/algoliasearch-client-swift", from: "8.0.0-beta.4")
     • 将 AlgoliaSearchClientSwift 添加到您的目标依赖项中。
2. 将 import AlgoliaSearchClientSwift 添加到您的源文件中。

Swift 4.2

1. 添加 InstantSearchClient 依赖
   • CocoaPods
     • 将以下代码添加到您的 Podfile 中：pod 'InstantSearchClient', '~> 6.0'。
   • Carthage
     • 将以下代码添加到您的 Cartfile 中：github "algolia/algoliasearch-client-swift" ~> 6.0.0。
   • Swift 包管理器
     • 将以下代码添加到您的 Package.swift 中的包依赖数组中：.package(url:"https://github.com/algolia/algoliasearch-client-swift", from: "6.0.0")。
     • 将 InstantSearchClient 添加到您的目标依赖中。
2. 将 import InstantSearchClient 添加到您的源文件中。

Swift 4.1

1. 添加 InstantSearchClient 依赖
   • CocoaPods
     • 将以下代码添加到您的 Podfile 中：pod ' InstantSearchClient', '~> 5.0' 。
   • Carthage
     • 将以下代码添加到您的 Cartfile 中：github "algolia/algoliasearch-client-swift" ~> 5.0.0。
   • Swift 包管理器
     • 将以下代码添加到您的 Package.swift 中的包依赖数组中：.package(url:"https://github.com/algolia/algoliasearch-client-swift", from: "5.0.0")。
     • 将 InstantSearchClient 添加到您的目标依赖中。
2. 将 import InstantSearchClient 添加到您的源文件中。

💡入门指南

初始化客户端

要开始，您需要客户端的 应用程序 ID 和 API 密钥。您可以在您的 Algolia 账户 上找到这两者。

let client = Client(appID: "YourApplicationID", apiKey: "YourAdminAPIKey")
let index = client.index(withName: "your_index_name")

推送数据

不进行任何之前的配置，您可以使用以下代码在 contacts 索引中开始索引联系人：

struct Contact {
  let firstname:  String
  let lastname: String
  let followersCount: Int
  let company: String
  let objectID: String
}

let index = client.index(withName: "contacts")

let contact = Contact(firstname: "Jimmie", 
		      lastname: "Barninger", 
		      followersCount: 93, 
		      company: "California Paint", 
		      objectID: "one")

try index.saveObject(contact)

搜索

您现在可以通过 firstname、lastname、company 等进行联系人搜索（甚至包括错误拼写）

// Synchronous search
let searchResponse = try index.search(query: "jimmie")

// Asynchronous search
index.search(query: "jimmie") { result in
  switch result {
  case .failure(let error):
    ...
  case .success(let searchResponse):
    ...
  }
}

有关完整文档，请访问 Algolia Swift API 客户端文档。

📝示例

您可以在 Algolia API 客户端沙箱 中找到代码示例。

📄许可

Algolia Swift API 客户端是开源软件，许可协议为 MIT 协议。