文档 • 社区论坛 • Stack Overflow • 报告 Bug • 常见问题解答 • 支持

• 纯跨平台 Swift 客户端
• 类型化请求和响应
• 广泛使用 Result 类型
• 使用 Codable 协议的强大功能，轻松集成您的领域模型
• 线程安全的客户端
• 详细的日志记录
• 可注入的 HTTP 客户端

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 Client，只需将以下行添加到您的 Podfile 中

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

• 从项目目录启动以下命令（对于 v.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。

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 issue

此存储库托管为 Swift 生成的 Algolia API 客户端的代码，如果您想贡献代码，请访问 主存储库。 您还可以在 我们的文档网站上找到贡献指南。

Algolia Swift API 客户端是一个在 MIT 许可证下获得许可的开源软件。