algoliasearch client swift

Der perfekte Ausgangspunkt, um Algolia in Ihr Swift-Projekt zu integrieren

Dokumentation • Community-Forum • Stapelüberlauf • Fehler melden • FAQ • Support

Merkmale

• Reiner plattformübergreifender Swift-Client
• Getippte Anfragen und Antworten
• Weit verbreitete Verwendung des Result
• Nutzt die Leistungsfähigkeit des Codable -Protokolls für die einfache Integration Ihrer Domänenmodelle
• Threadsichere Clients
• Detaillierte Protokollierung
• Injizierbarer HTTP-Client

Erste Schritte

Swift-Paketmanager

Der Swift Package Manager ist ein Tool zur Verwaltung der Verteilung von Swift-Code. Es ist in das Swift-Build-System integriert, um den Prozess des Herunterladens, Kompilierens und Verknüpfens von Abhängigkeiten zu automatisieren. Seit der Veröffentlichung von Swift 5 und Xcode 11 ist SPM mit den Build-Systemen iOS, macOS und tvOS zum Erstellen von Apps kompatibel.

Um SwiftPM zu verwenden, sollten Sie Xcode 11 zum Öffnen Ihres Projekts verwenden. Klicken Sie auf File -> Swift Packages -> Add Package Dependency und geben Sie die URL des Client-Repos ein.

Wenn Sie ein Framework-Autor sind und Swift API Client als Abhängigkeit verwenden, aktualisieren Sie Ihre Package.swift Datei:

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

Kakaokapseln

CocoaPods ist ein Abhängigkeitsmanager für Cocoa-Projekte.

Um den Algolia Swift Client zu installieren, fügen Sie einfach die folgende Zeile zu Ihrer Poddatei hinzu:

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

Führen Sie dann den folgenden Befehl aus:

$ pod update

Karthago

Carthage ist ein einfacher, dezentraler Abhängigkeitsmanager für Cocoa.

• Um InstantSearch zu installieren, fügen Sie einfach die folgende Zeile zu Ihrer Cartfile hinzu:

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

• Starten Sie die folgenden Befehle aus dem Projektverzeichnis (für v.8.0+)

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

Wenn Sie Carthage zum ersten Mal in dem Projekt verwenden, müssen Sie einige zusätzliche Schritte ausführen, wie oben bei Carthage erläutert.

Sie können jetzt den Algolia API-Client in Ihr Projekt importieren und damit spielen.

Importieren Sie das Core-Paket und das erforderliche Client-Paket in Ihre Quellcodedateien:

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

Eine vollständige Dokumentation finden Sie im Algolia Swift API Client .

Notizen

Objective-C-Unterstützung

Der Swift API-Client ist mit Objective-C bis Version 7.0.5 kompatibel. Bitte verwenden Sie diese Version des Clients, wenn Sie mit einem Objective-C-Projekt arbeiten.

Schnell 3

Sie können diese Bibliothek mit Swift auf eine der folgenden Arten verwenden:

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

Schnell 4

Sie können die alte Bibliothek mit Swift auf eine der folgenden Arten verwenden:

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

❓ Fehlerbehebung

Sie stoßen auf ein Problem? Bevor Sie sich an den Support wenden, empfehlen wir Ihnen, unsere FAQ zu lesen, wo Sie Antworten auf die häufigsten Probleme und Fallstricke des Kunden finden. Sie können auch ein GitHub-Problem öffnen

Mitwirken

Dieses Repository hostet den Code des generierten Algolia API-Clients für Swift. Wenn Sie einen Beitrag leisten möchten, gehen Sie zum Haupt-Repository. Auf unserer Dokumentationswebsite finden Sie auch beitragende Leitfäden.

? Lizenz

Der Algolia Swift API Client ist eine Open-Source-Software, die unter der MIT-Lizenz lizenziert ist.