algoliasearch client swift

Titik awal yang sempurna untuk mengintegrasikan Algolia dalam proyek Swift Anda

Dokumentasi • Forum Komunitas • Stack Overflow • Laporkan bug • FAQ • Dukungan

Fitur

• Klien Swift lintas platform murni
• Permintaan dan tanggapan yang diketik
• Penggunaan tipe Result secara luas
• Menggunakan kekuatan protokol Codable untuk memudahkan integrasi model domain Anda
• Klien yang aman untuk thread
• Pencatatan log yang mendetail
• Klien HTTP yang dapat disuntikkan

Memulai

Manajer Paket Swift

Swift Package Manager adalah alat untuk mengelola distribusi kode Swift. Ini terintegrasi dengan sistem build Swift untuk mengotomatiskan proses pengunduhan, kompilasi, dan menghubungkan dependensi. Sejak rilis Swift 5 dan Xcode 11, SPM kompatibel dengan sistem build iOS, macOS, dan tvOS untuk membuat aplikasi.

Untuk menggunakan SwiftPM, Anda harus menggunakan Xcode 11 untuk membuka proyek Anda. Klik File -> Swift Packages -> Add Package Dependency , masukkan URL repo klien.

Jika Anda adalah pembuat kerangka kerja dan menggunakan Klien API Swift sebagai ketergantungan, perbarui file Package.swift Anda:

 let package = Package (
    // 9.0.0 ..< 10.0.0
    dependencies : [
        . package ( url : " https://github.com/algolia/algoliasearch-client-swift " , from : " 9.0.0 " )
    ] ,
    // ...
)

kakaopoda

CocoaPods adalah manajer ketergantungan untuk proyek Kakao.

Untuk menginstal Algolia Swift Client, cukup tambahkan baris berikut ke Podfile Anda:

 pod 'AlgoliaSearchClient' , '~> 9.0.0'
# pod 'InstantSearchClient', '~> 7.0' // Swift 5.9 NOT YET RELEASED

Kemudian, jalankan perintah berikut:

$ pod update

Kartago

Carthage adalah manajer ketergantungan yang sederhana dan terdesentralisasi untuk Kakao.

• Untuk menginstal InstantSearch, cukup tambahkan baris berikut ke Cartfile Anda:

 github "algolia/algoliasearch-client-swift" ~> 9.0 . 0

• Luncurkan perintah berikut dari direktori proyek (untuk v.8.0+)

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

Jika ini adalah pertama kalinya Anda menggunakan Carthage dalam proyek ini, Anda harus melalui beberapa langkah tambahan seperti yang dijelaskan di Carthage.

Anda sekarang dapat mengimpor klien Algolia API di proyek Anda dan memainkannya.

Impor paket Inti dan paket klien yang diperlukan ke file kode sumber Anda:

 #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> "
    ) ) ] ) )

Untuk dokumentasi lengkap, kunjungi Algolia Swift API Client .

Catatan

Dukungan Objective-C

Klien Swift API kompatibel dengan Objective-C hingga versi 7.0.5. Silakan gunakan versi klien ini jika Anda bekerja dengan proyek Objective-C.

Cepat 3

Anda dapat menggunakan perpustakaan ini dengan Swift dengan salah satu cara berikut:

• pod 'AlgoliaSearch-Client-Swift', '~> 4.8.1'
• pod 'AlgoliaSearch-Client-Swift', :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :branch => 'swift-3'

Cepat 4

Anda dapat menggunakan perpustakaan lama dengan Swift dengan salah satu cara berikut:

• pod 'AlgoliaSearch-Client-Swift', '~> 8.19'
• pod 'AlgoliaSearch-Client-Swift', :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :branch => 'swift-4'

❓ Pemecahan masalah

Mengalami masalah? Sebelum menghubungi dukungan, kami sarankan untuk membuka FAQ kami di mana Anda akan menemukan jawaban untuk masalah paling umum dan masalah yang dihadapi klien. Anda juga dapat membuka masalah GitHub

Berkontribusi

Repositori ini menampung kode klien API Algolia yang dihasilkan untuk Swift, jika Anda ingin berkontribusi, kunjungi repositori utama. Anda juga dapat menemukan panduan berkontribusi di situs dokumentasi kami.

? Lisensi

Klien API Algolia Swift adalah perangkat lunak sumber terbuka yang dilisensikan di bawah lisensi MIT.