api clients automation

Automatisation des clients API

Les clients de l'API Algolia sont générés à partir des spécifications OpenAPI, en tirant parti de l'outil open-source openapi-generator.

Documentation d'automatisation des clients API • Documentation Algolia

Note de migration des clients API actuels

En juillet 2022, nous avons publié une version alpha de clients API générés pour les langages JavaScript, Java et PHP. Si vous utilisez la dernière version stable de ces clients et souhaitez effectuer une mise à niveau, lisez le guide de migration. Vous pouvez toujours parcourir la documentation des clients stables sur la documentation Algolia.

Premiers pas avec les clients

Vous pouvez lire les guides getting started et comment utiliser les clients API dans notre documentation.

Contribuer

Vous cherchez à ajouter un nouveau client ou à corriger un bug ? Assurez-vous de jeter un œil à nos guides de contribution.

Configurer les outils du référentiel

nvm use && yarn

Configurer l'environnement de développement

Assurez-vous d'avoir Docker installé afin de ne pas avoir à installer les outils pour chaque client API.

yarn docker:setup

En savoir plus sur notre documentation

CLI

La CLI vous permet d'apporter des modifications localement et d'exécuter des commandes via le conteneur Docker.

• Commandes CLI de spécifications
• Commandes CLI client
• Commandes CLI CTS

Guides et exigences

Lisez les guides et les exigences pour :

• Ajouter un nouveau client
• Ajouter une nouvelle langue

Essais

Testez les clients générés en exécutant :

• L' playground (voir documentation)
• La Common Test Suite (voir documentation).

Pour une documentation complète, visitez la documentation en ligne .

❓ Dépannage

Vous rencontrez un problème avec les clients API ? 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 sur GitHub.

? Licence

L'automatisation des clients API Algolia est un logiciel open source sous licence MIT.