ドキュメント • コミュニティ フォーラム • スタック オーバーフロー • バグの報告 • FAQ • サポート
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 クライアントを使用している場合は、 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 用のシンプルな分散依存関係マネージャーです。
github "algolia/algoliasearch-client-swift" ~> 9.0 . 0
carthage update
./Carthage/Checkouts/algoliasearch-client-swift/carthage-prebuild
carthage build
プロジェクトで Carthage を初めて使用する場合は、Carthage で説明されているように、いくつかの追加手順を実行する必要があります。
これで、Algolia API クライアントをプロジェクトにインポートして操作できるようになりました。
コア パッケージと必要なクライアント パッケージをソース コード ファイルにインポートします。
#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 クライアントは、バージョン 7.0.5 までの Objective-C と互換性があります。 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'
問題が発生しましたか?サポートに問い合わせる前に、FAQ にアクセスして、クライアントとの最も一般的な問題や注意点に対する回答を見つけることをお勧めします。 GitHub の問題を開くこともできます
このリポジトリは、Swift 用に生成された Algolia API クライアントのコードをホストします。貢献したい場合は、メイン リポジトリに移動してください。また、当社のドキュメント Web サイトで貢献ガイドを見つけることもできます。
Algolia Swift API クライアントは、MIT ライセンスに基づいてライセンス供与されたオープンソース ソフトウェアです。