algoliasearch client swift

El punto de partida perfecto para integrar Algolia en tu proyecto Swift

Documentación • Foro de la comunidad • Desbordamiento de pila • Informar un error • Preguntas frecuentes • Soporte

Características

• Cliente Swift multiplataforma puro
• Solicitudes y respuestas escritas
• Uso generalizado del tipo de Result
• Utiliza el poder del protocolo Codable para una fácil integración de sus modelos de dominio
• Clientes seguros para subprocesos
• Registro detallado
• Cliente HTTP inyectable

Empezando

Administrador de paquetes rápido

Swift Package Manager es una herramienta para gestionar la distribución de código Swift. Está integrado con el sistema de compilación Swift para automatizar el proceso de descarga, compilación y vinculación de dependencias. Desde el lanzamiento de Swift 5 y Xcode 11, SPM es compatible con los sistemas de compilación iOS, macOS y tvOS para crear aplicaciones.

Para usar SwiftPM, debe usar Xcode 11 para abrir su proyecto. Haga clic en File -> Swift Packages -> Add Package Dependency , ingrese la URL del repositorio del cliente.

Si es autor de un marco y utiliza Swift API Client como dependencia, actualice su archivo 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 " )
    ] ,
    // ...
)

Cocoápodos

CocoaPods es un administrador de dependencias para proyectos Cocoa.

Para instalar Algolia Swift Client, simplemente agregue la siguiente línea a su Podfile:

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

Luego, ejecute el siguiente comando:

$ pod update

Cartago

Carthage es un administrador de dependencias simple y descentralizado para Cocoa.

• Para instalar InstantSearch, simplemente agregue la siguiente línea a su Cartfile:

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

• Inicie los siguientes comandos desde el directorio del proyecto (para v.8.0+)

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

Si es la primera vez que utiliza Carthage en el proyecto, deberá seguir algunos pasos adicionales como se explica en Carthage.

Ahora puedes importar el cliente API de Algolia en tu proyecto y jugar con él.

Importe el paquete Core y el paquete de cliente requerido a sus archivos de código fuente:

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

Para obtener la documentación completa, visite el cliente API de Algolia Swift .

Notas

Soporte Objective-C

El cliente Swift API es compatible con Objective-C hasta la versión 7.0.5. Utilice esta versión del cliente si está trabajando con un proyecto Objective-C.

veloz 3

Puede utilizar esta biblioteca con Swift de una de las siguientes maneras:

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

veloz 4

Puede utilizar la biblioteca antigua con Swift de una de las siguientes maneras:

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

❓ Solución de problemas

¿Tiene algún problema? Antes de comunicarse con el soporte, le recomendamos que consulte nuestras preguntas frecuentes, donde encontrará respuestas a los problemas y problemas más comunes con el cliente. También puedes abrir una incidencia de GitHub.

Contribuyendo

Este repositorio aloja el código del cliente API de Algolia generado para Swift. Si desea contribuir, diríjase al repositorio principal. También puede encontrar guías contribuyentes en nuestro sitio web de documentación.

? Licencia

Algolia Swift API Client es un software de código abierto con licencia MIT.