algoliasearch client swift

Le point de départ idéal pour intégrer Algolia dans votre projet Swift

Documentation • Forum communautaire • Stack Overflow • Signaler un bug • FAQ • Support

Caractéristiques

• Client Swift multiplateforme pur
• Demandes et réponses dactylographiées
• Utilisation généralisée du type Result
• Utilise la puissance du protocole Codable pour une intégration facile de vos modèles de domaine
• Clients thread-safe
• Journalisation détaillée
• Client HTTP injectable

Commencer

Gestionnaire de paquets Swift

Le Swift Package Manager est un outil de gestion de la distribution du code Swift. Il est intégré au système de build Swift pour automatiser le processus de téléchargement, de compilation et de liaison des dépendances. Depuis la sortie de Swift 5 et Xcode 11, SPM est compatible avec les systèmes de build iOS, macOS et tvOS pour créer des applications.

Pour utiliser SwiftPM, vous devez utiliser Xcode 11 pour ouvrir votre projet. Cliquez sur File -> Swift Packages -> Add Package Dependency , entrez l'URL du dépôt client.

Si vous êtes un auteur de framework et utilisez Swift API Client comme dépendance, mettez à jour votre fichier 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

CocoaPods est un gestionnaire de dépendances pour les projets Cocoa.

Pour installer Algolia Swift Client, ajoutez simplement la ligne suivante à votre Podfile :

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

Ensuite, exécutez la commande suivante :

$ pod update

Carthage

Carthage est un gestionnaire de dépendances simple et décentralisé pour Cocoa.

• Pour installer InstantSearch, ajoutez simplement la ligne suivante à votre Cartfile :

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

• Lancez les commandes suivantes depuis le répertoire du projet (pour v.8.0+)

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

Si c'est la première fois que vous utilisez Carthage dans le projet, vous devrez suivre quelques étapes supplémentaires comme expliqué à Carthage.

Vous pouvez désormais importer le client API Algolia dans votre projet et jouer avec.

Importez le package Core et le package client requis dans vos fichiers de code source :

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

Pour une documentation complète, visitez le client API Algolia Swift .

Remarques

Prise en charge d'Objective-C

Le client Swift API est compatible avec Objective-C jusqu'à la version 7.0.5. Veuillez utiliser cette version du client si vous travaillez avec un projet Objective-C.

Rapide 3

Vous pouvez utiliser cette bibliothèque avec Swift de l'une des manières suivantes :

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

Rapide 4

Vous pouvez utiliser l'ancienne bibliothèque avec Swift de l'une des manières suivantes :

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

❓ Dépannage

Vous rencontrez un problème ? Avant de contacter l'assistance, nous vous recommandons de consulter notre FAQ où vous trouverez des réponses aux problèmes et pièges les plus courants avec le client. Vous pouvez également ouvrir un ticket GitHub

Contribuer

Ce référentiel héberge le code du client API Algolia généré pour Swift, si vous souhaitez contribuer, rendez-vous sur le référentiel principal. Vous pouvez également trouver des guides de contribution sur notre site Web de documentation.

? Licence

Le client API Algolia Swift est un logiciel open source sous licence MIT.