L'interface de ligne de commande (CLI) Apidog est le point d'entrée pour exécuter des tests d'API depuis un terminal, un pipeline CI, un workflow d'automatisation ou un système externe.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>
Cette base reste essentielle : exécuter des tests d'API, générer des rapports et maintenir des portes de qualité dans la CI. Mais les workflows API évoluent. Les Agents IA interviennent désormais dans la conception d'API, la génération de tests, le débogage, la migration et la maintenance.
Pour ces usages, une CLI ne doit pas seulement exécuter des tests existants. Elle doit aussi permettre aux Agents de lire les ressources d'API, créer ou mettre à jour des ressources de test, valider des modifications structurées, les écrire, puis vérifier le résultat.
La CLI Apidog mise à niveau conserve l'exécution de tests et ajoute une couche de workflow pour les développeurs, les scripts et les Agents IA. Voici comment l'utiliser pour automatiser les tests d'API de manière plus contrôlée.
Pourquoi la CLI devient centrale avec les Agents IA
Les interfaces graphiques sont adaptées aux humains : exploration visuelle, collaboration, revue et débogage. Les Agents IA, eux, fonctionnent mieux avec :
- des commandes structurées ;
- des entrées prévisibles ;
- des sorties exploitables ;
- des étapes de validation explicites ;
- des boucles de vérification répétables.
La CLI fournit cette interface répétable vers les ressources gérées dans Apidog :
- APIs ;
- environnements ;
- variables ;
- cas de test ;
- scénarios de test ;
- suites de test ;
- rapports ;
- workflows d'import/export ;
- ressources projet associées.
En pratique, l'interface Apidog reste l'espace de conception, de débogage et de collaboration pour les équipes. La CLI devient l'interface stable pour les scripts, la CI et les Agents IA.
De apidog run aux workflows complets d'API et de test
L'ancienne expérience CLI était surtout centrée sur l'exécution des tests. apidog run reste utile comme garde-fou qualité dans la CI, mais il intervenait généralement à la fin du workflow.
La CLI mise à niveau couvre davantage de ressources Apidog. L'automatisation peut donc intervenir plus tôt :
- lire le contexte du projet ;
- préparer ou modifier des ressources de test ;
- valider des fichiers structurés ;
- écrire les modifications ;
- relire les ressources sauvegardées ;
- exécuter les tests.
Avec la CLI mise à niveau, les utilisateurs et les Agents peuvent travailler avec des ressources telles que :
- projets et métadonnées de projet ;
- APIs et définitions d'API ;
- environnements et variables ;
- cas de test ;
- scénarios de test ;
- suites de test ;
- rapports ;
- workflows d'importation et d'exportation ;
- comptes, branches, exécuteurs et ressources de projet associées.
La CLI Apidog n'est donc plus uniquement une commande d'exécution. Elle peut participer au cycle de développement dès qu'un Agent doit comprendre un projet, générer ou mettre à jour des ressources de test, valider ses changements, puis lancer la vérification.
Mettre en place une boucle plus sûre pour les tests pilotés par Agents
Le risque principal avec un Agent IA n'est pas seulement la génération de contenu. Le risque vient surtout de l'écriture de contenu généré dans un projet réel sans validation suffisante.
Une boucle plus sûre consiste à faire suivre à l'Agent ce chemin :
- lire les ressources existantes ;
- générer une modification structurée ;
- valider le schéma ;
- écrire dans Apidog ;
- relire la ressource sauvegardée ;
- exécuter les tests si nécessaire.
Cette boucle est importante car les ressources Apidog sont structurées. Les cas de test et les scénarios peuvent inclure :
- données de requête ;
- assertions ;
- extraction de variables ;
- pré-processeurs ;
- post-processeurs ;
- ordre des étapes ;
- références à des environnements ;
- autres paramètres d'exécution.
Si un Agent devine la structure, de petites erreurs peuvent provoquer des échecs d'écriture, un affichage incomplet dans l'interface ou des tests au comportement inattendu.
Utilisez donc cli-schema avant d'écrire des fichiers JSON complexes dans Apidog :
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.json
Principe simple : laissez l'Agent générer, mais laissez la CLI valider avant l'écriture.
Après une création ou une mise à jour, ne terminez pas le workflow immédiatement. Demandez à l'Agent de relire la ressource sauvegardée, de vérifier la structure et d'exécuter les tests si nécessaire. Les sorties de commande peuvent aussi fournir des indices orientés Agent pour guider ces étapes suivantes.
Utiliser les Compétences pour guider les Agents
Les commandes CLI donnent à un Agent la capacité d'agir. Les Compétences l'aident à agir dans le bon ordre.
Une COMPÉTENCE n'est pas seulement une référence de commande. C'est un guide opérationnel pour Agents IA qui précise :
- quand utiliser une commande ;
- quelle commande exécuter en premier ;
- quels champs ne doivent pas être devinés ;
- quand valider ;
- quand relire ;
- quand exécuter les tests.
Par exemple, pour créer un scénario de test complexe, évitez de demander à l'Agent d'écrire tout le scénario à la main en une seule passe. Un workflow plus sûr est :
- créer le scénario de base ;
- importer des étapes depuis des APIs ou cas de test existants ;
- relire la structure complète du scénario ;
- mettre à jour les assertions, extractions de variables ou processeurs par petites étapes ;
- valider ;
- exécuter le scénario.
Les Compétences rendent ces modèles explicites. Elles aident les Agents à éviter les erreurs courantes :
- nom de champ incorrect ;
- valeur d'énumération invalide ;
- validation de schéma oubliée ;
- hypothèse qu'une écriture réussie signifie que la ressource finale est correcte.
Apidog fournit 8 Compétences complémentaires pour aider les Agents à comprendre les commandes CLI, les structures de ressources et les workflows de tâches. Ensemble, la CLI et les Compétences rendent Apidog plus pratique pour le développement et les tests d'API assistés par IA.
Sécuriser les modifications avec les Branches IA
Lorsqu'un Agent modifie des ressources de projet, les changements doivent rester révisables. Pour cela, la CLI mise à niveau peut être utilisée avec les Branches IA.
Workflow recommandé :
- l'Agent applique ses changements dans une branche isolée ;
- l'équipe examine les différences ;
- l'équipe confirme le résultat ;
- les changements sont fusionnés dans la branche cible.
Cela évite que les modifications automatisées affectent directement la branche principale ou une branche de collaboration partagée.
Workflows concrets avec la CLI Apidog
Générer des tests à partir des définitions d'API
Un Agent peut transformer des définitions d'API en cas de test avec une boucle contrôlée :
- lire les définitions d'API du projet ;
- générer les cas de test ;
- valider le JSON avec
cli-schema; - écrire les cas de test dans Apidog ;
- relire les cas sauvegardés ;
- exécuter la vérification.
Ce workflow transforme la génération de tests en processus vérifiable, plutôt qu'en simple suggestion ponctuelle.
Maintenir des scénarios de test complexes
Pour les scénarios à plusieurs étapes, utilisez les APIs ou les cas de test existants comme base. L'Agent peut importer des étapes, puis modifier progressivement les assertions, variables ou processeurs.
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detail
Ce modèle réduit le risque de générer un scénario volumineux et incorrect en une seule passe.
Déplacer ou reproduire des ressources de projet
La CLI mise à niveau améliore aussi les workflows d'importation et d'exportation pour les données natives Apidog. C'est utile pour :
- migrer des projets ;
- reproduire des environnements clients ;
- copier des configurations de test ;
- déplacer des APIs, schémas, cas de test et scénarios entre projets.
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.json
Maintenir les portes de qualité CI
Les capacités orientées Agents ne remplacent pas la CI. Elles la complètent.
Continuez à utiliser apidog run comme point d'entrée pour l'exécution automatisée des tests et la génération de rapports :
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reports
Pour commencer
Si la CLI Apidog est déjà installée, vérifiez d'abord la version :
apidog -v
Si la version de votre CLI Apidog est antérieure à 2.2.5, mettez-la à jour avant d'utiliser les nouvelles fonctionnalités. Ce numéro concerne la CLI Apidog, pas l'application Apidog.
Vous pouvez demander à votre Agent IA d'installer la CLI Apidog et les Compétences complémentaires avec cette invite :
Lisez les instructions et aidez-moi à installer la CLI Apidog :
https://apidog.com/apidog-cli-installation-guide.md?utm_source=dev.to&utm_medium=wanda&utm_content=n8n-post-automation
Pour une installation ou mise à jour manuelle :
npm install -g apidog-cli@latest
Pour la référence complète des commandes, consultez les Options de la CLI Apidog.
Essayez votre première tâche d'Agent
Après installation de la CLI et des Compétences, commencez par une tâche API simple et à faible risque.
Exemple : demander à l'Agent de créer un endpoint de vérification de santé GET /health, puis de relire la ressource pour confirmer le résultat.
Copiez cette invite dans votre Agent IA :
Utilisez la CLI Apidog pour m'aider à créer mon premier point d'accès API dans Apidog. D'abord, vérifiez ma configuration CLI Apidog et listez les projets auxquels j'ai accès. Demandez-moi quel projet utiliser. Après ma confirmation, créez un simple point d'accès GET /health nommé "Vérification de Santé" avec un exemple de réponse 200. Validez toute entrée structurée avant l'écriture, puis relisez le point d'accès et résumez ce qui a été créé.
Ce premier workflow force les bonnes pratiques :
- vérifier la configuration ;
- lister les projets disponibles ;
- demander confirmation avant écriture ;
- créer une petite définition d'API ;
- valider les entrées structurées ;
- relire la ressource sauvegardée ;
- résumer le résultat.
Prochaines étapes :
- Téléchargez Apidog pour concevoir, déboguer, tester et documenter des API dans un seul espace de travail.
- En savoir plus sur la CLI Apidog pour les tests d'API en ligne de commande, l'automatisation CI et les workflows d'Agents IA.
FAQ
Qu'est-ce que la CLI Apidog ?
La CLI Apidog est un outil en ligne de commande pour exécuter des tests d'API, travailler avec les ressources de projet Apidog et connecter les ressources d'API et de test Apidog aux workflows d'automatisation.
La CLI Apidog peut-elle exécuter des tests d'API en CI ?
Oui. Utilisez apidog run dans vos pipelines CI pour exécuter des tests d'API, générer des rapports et maintenir des portes de qualité automatisées.
Comment la CLI Apidog aide-t-elle les Agents IA ?
Elle fournit aux Agents IA un moyen structuré de lire les informations d'API, générer ou mettre à jour des ressources de test, valider les modifications, les écrire dans Apidog, relire le résultat et exécuter les tests de vérification.
Qu'est-ce que cli-schema dans la CLI Apidog ?
cli-schema permet de valider des fichiers JSON complexes avant leur écriture dans Apidog. Cela réduit les échecs d'écriture, les champs invalides et les boucles de réessai inutiles lorsque les Agents créent ou mettent à jour des cas de test et des scénarios de test.
Comment installer la CLI Apidog ?
Vous pouvez demander à un Agent IA de suivre le guide d'installation de la CLI Apidog et d'installer la CLI avec les Compétences complémentaires. Vous pouvez aussi l'installer manuellement :
bash
npm install -g apidog-cli@latest
Top comments (0)