api clients automation

Automação de clientes API

Os clientes da API Algolia são gerados a partir de especificações OpenAPI, aproveitando a ferramenta open-source openapi-generator.

Documentação de automação de clientes API • Documentação Algolia

Nota de migração dos clientes atuais da API

Em julho de 2022, lançamos uma versão alfa de clientes API gerados para as linguagens JavaScript, Java e PHP. Se você estiver usando o último estável desses clientes e deseja atualizar, leia o guia de migração. Você ainda pode navegar pela documentação dos clientes estáveis ​​na documentação Algolia.

Primeiros passos com os clientes

Você pode ler guias getting started e como usar os clientes API em nossa documentação.

Contribuindo

Quer adicionar um novo cliente ou corrigir um bug? Certifique-se de dar uma olhada em nossos guias de contribuição.

Configurar ferramentas de repositório

nvm use && yarn

Configurar ambiente de desenvolvimento

Certifique-se de ter o Docker instalado para não precisar instalar as ferramentas para todos os clientes da API.

yarn docker:setup

Leia mais em nossa documentação

CLI

A CLI permite fazer alterações localmente e executar comandos por meio do contêiner docker.

• Comandos CLI de especificações
• Comandos CLI de clientes
• Comandos CLI do CTS

Guias e requisitos

Leia os guias e requisitos para:

• Adicionar um novo cliente
• Adicionar um novo idioma

Testes

Teste os clientes gerados executando:

• O playground (ver documentação)
• O Common Test Suite (consulte a documentação).

Para obter a documentação completa, visite a documentação on-line .

❓ Solução de problemas

Encontrando um problema com os clientes da API? 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 no GitHub.

? Licença

A automação de clientes Algolia API é um software de código aberto licenciado sob a licença MIT.