algoliasearch client swift

O ponto de partida perfeito para integrar Algolia em seu projeto Swift

Documentação • Fórum da comunidade • Stack Overflow • Relatar um bug • Perguntas frequentes • Suporte

Características

• Cliente Swift multiplataforma puro
• Solicitações e respostas digitadas
• Uso generalizado do tipo Result
• Usa o poder do protocolo Codable para fácil integração de seus modelos de domínio
• Clientes thread-safe
• Registro detalhado
• Cliente HTTP injetável

Começando

Gerenciador de pacotes Swift

O Swift Package Manager é uma ferramenta para gerenciar a distribuição de código Swift. Está integrado ao sistema de compilação Swift para automatizar o processo de download, compilação e vinculação de dependências. Desde o lançamento do Swift 5 e Xcode 11, o SPM é compatível com os sistemas de construção iOS, macOS e tvOS para criação de aplicativos.

Para usar o SwiftPM, você deve usar o Xcode 11 para abrir seu projeto. Clique em File -> Swift Packages -> Add Package Dependency e insira o URL do repositório do cliente.

Se você é um autor de estrutura e usa o Swift API Client como dependência, atualize seu arquivo 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ápodes

CocoaPods é um gerenciador de dependências para projetos Cocoa.

Para instalar o Algolia Swift Client, basta adicionar a seguinte linha ao seu Podfile:

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

Em seguida, execute o seguinte comando:

$ pod update

Cartago

Carthage é um gerenciador de dependências simples e descentralizado para Cocoa.

• Para instalar o InstantSearch, basta adicionar a seguinte linha ao seu Cartfile:

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

• Inicie os seguintes comandos no diretório do projeto (para v.8.0+)

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

Se esta é a primeira vez que usa Carthage no projeto, você precisará seguir algumas etapas adicionais conforme explicado em Carthage.

Agora você pode importar o cliente Algolia API em seu projeto e brincar com ele.

Importe o pacote Core e o pacote do cliente necessário para seus arquivos de código-fonte:

 #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 documentação completa, visite Algolia Swift API Client .

Notas

Suporte Objective-C

O cliente Swift API é compatível com Objective-C até a versão 7.0.5. Use esta versão do cliente se estiver trabalhando com um projeto Objective-C.

Rápido 3

Você pode usar esta biblioteca com Swift de uma das seguintes maneiras:

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

Rápido 4

Você pode usar a biblioteca antiga com Swift de uma das seguintes maneiras:

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

❓ Solução de problemas

Encontrando um problema? Antes de entrar em contato com o suporte, recomendamos acessar nosso FAQ, onde você encontrará respostas para os problemas e pegadinhas mais comuns do cliente. Você também pode abrir um problema do GitHub

Contribuindo

Este repositório hospeda o código do cliente Algolia API gerado para Swift, se você quiser contribuir, vá para o repositório principal. Você também pode encontrar guias de contribuição em nosso site de documentação.

? Licença

O Algolia Swift API Client é um software de código aberto licenciado sob a licença MIT.