L'interface de ligne de commande (CLI) Apidog a longtemps été 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. Les équipes ont toujours besoin d'un moyen fiable pour exécuter des tests d'API, générer des rapports et maintenir des portes de qualité au sein de la CI. Mais le développement d'API évolue. Les Agents IA participent désormais à la conception d'API, à la génération de tests, au débogage, à la migration et à la maintenance.
Pour ces workflows, une CLI ne peut pas se limiter à être la dernière étape qui exécute des tests existants. Elle doit également offrir aux Agents un moyen stable de lire les ressources d'API, de créer ou de mettre à jour des ressources de test, de valider des modifications structurées, de les réécrire et de vérifier le résultat.
La CLI Apidog mise à niveau conserve la base d'exécution de tests d'origine et l'étend à une couche de workflow pour les développeurs, les scripts et les Agents IA. Cet article explique pourquoi la CLI est plus importante à l'ère des Agents IA, ce qui a changé dans la CLI Apidog, et comment les équipes peuvent commencer à l'utiliser pour l'automatisation des tests d'API.
Pourquoi la CLI est plus importante à l'ère des Agents IA
Les interfaces graphiques sont conçues pour les humains. Elles sont visuelles, flexibles et utiles pour l'exploration. Les Agents IA, cependant, fonctionnent mieux avec des commandes structurées, des entrées prévisibles, des sorties prévisibles et des étapes de validation claires.
C'est là que la CLI devient importante. Une CLI offre aux Agents et aux scripts une interface répétable vers les mêmes ressources que les développeurs gèrent dans Apidog : APIs, environnements, variables, cas de test, scénarios de test, suites de test, rapports, données d'import/export, et plus encore.
En pratique, cela signifie qu'Apidog peut servir à la fois les utilisateurs humains et les workflows automatisés. Les personnes continuent de concevoir, déboguer, réviser et collaborer dans l'interface du produit. Les Agents et l'automatisation peuvent utiliser la CLI pour effectuer des opérations contrôlées sur ces mêmes ressources.
De apidog run aux workflows complets d'API et de test
L'expérience CLI précédente était principalement axée sur l'exécution des tests. Cela rendait apidog run utile comme garde-fou qualité CI, mais cela signifiait aussi que la CLI apparaissait généralement vers la fin du workflow. La CLI mise à niveau étend la couverture à davantage de ressources Apidog principales, de sorte que l'automatisation peut participer plus tôt : lecture du contexte du projet, préparation des ressources de test, validation des modifications structurées, puis exécution de la vérification.
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
Cela change le rôle de la CLI Apidog. Ce n'est pas simplement un moyen d'exécuter des tests une fois que tout le reste est terminé. Elle peut désormais participer plus tôt au cycle de développement, là où un Agent a besoin de comprendre le projet, de générer ou de mettre à jour des ressources de test, de valider les modifications, puis d'exécuter la vérification.
Une boucle plus sûre pour les tests pilotés par les Agents
Lorsqu'un Agent IA aide au développement ou aux tests d'API, le risque ne réside pas seulement dans la génération de contenu. Le risque réside dans l'écriture de contenu généré dans un projet réel sans structure ni vérification suffisantes.
La CLI mise à niveau rend une boucle plus sûre possible :
Cette boucle est importante car de nombreuses ressources Apidog sont structurées. Les cas de test et les scénarios de test peuvent inclure des données de requête, des assertions, l'extraction de variables, des pré-processeurs, des post-processeurs, l'ordre des étapes, des références à des environnements et d'autres détails. Si un Agent devine la structure, de petites erreurs peuvent entraîner des échecs d'écriture, un affichage incomplet dans l'interface utilisateur ou des tests qui ne se comportent pas comme prévu.
C'est pourquoi cli-schema est un élément important de la mise à niveau. Avant d'écrire un fichier JSON complexe dans Apidog, un Agent peut demander à la CLI de valider si les champs et la structure correspondent au schéma attendu.
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.jsonEn bref : laissez l'Agent générer, mais laissez la CLI valider avant que l'écriture ne se produise.
La CLI peut également fournir des indices orientés Agent dans la sortie des commandes. Après la création ou la mise à jour d'une ressource, l'étape suivante n'est souvent pas "arrêter". Un Agent plus fiable devrait relire la ressource sauvegardée, confirmer la structure et exécuter des tests si nécessaire. Ces indices aident les Agents à progresser dans le workflow avec moins d'angles morts.
Les Compétences donnent aux Agents un jugement opérationnel
Les commandes CLI donnent à un Agent le pouvoir d'exécution. Les Compétences donnent à un Agent un jugement opérationnel.
Une COMPÉTENCE n'est pas seulement une référence de commande. C'est plus proche d'un guide opérationnel écrit pour les Agents IA : quand utiliser une commande, quelle commande doit venir en premier, quels champs ne doivent pas être devinés, quand valider, quand relire, et quand exécuter des tests.
Par exemple, un Agent fiable ne devrait pas toujours écrire un grand scénario de test à la main à partir de zéro. Un modèle plus sûr est souvent :
- Créer le scénario de base.
- Importer des étapes à partir d'APIs ou de cas de test existants.
- Relire la structure complète du scénario.
- Mettre à jour les assertions, l'extraction de variables ou les processeurs par étapes plus petites.
- Valider et exécuter le scénario.
Les Compétences rendent ces modèles explicites. Elles aident les Agents à éviter les erreurs courantes telles que l'utilisation d'un nom de champ incorrect, le choix d'une valeur d'énumération erronée, l'omission de la validation du schéma, ou la supposition qu'une écriture réussie signifie que la ressource finale est déjà 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.
Modifications de projet plus sûres avec les Branches IA
Lorsqu'un Agent modifie les ressources d'un projet, la sécurité et la possibilité de révision sont importantes. Pour cette raison, la CLI mise à niveau peut également être utilisée conjointement avec les Branches IA.
L'Agent peut d'abord apporter des modifications dans une branche isolée. L'équipe peut examiner les différences, confirmer le résultat, puis fusionner dans la branche cible. Cela permet d'éviter que les modifications automatisées n'affectent directement la branche principale ou une branche de collaboration partagée.
Ce que cela débloque dans les workflows réels
La valeur de la CLI mise à niveau est plus facile à voir dans des workflows concrets.
Générer des tests à partir des définitions d'API
Un Agent peut lire les définitions d'API d'un projet, générer des cas de test, valider le JSON généré avec cli-schema, écrire les cas de test dans Apidog, les relire et exécuter la vérification. Cela transforme la génération de tests d'une suggestion ponctuelle en un workflow contrôlé.
Maintenir des scénarios de test complexes
Pour les scénarios à plusieurs étapes, l'Agent peut d'abord importer des étapes à partir d'APIs ou de cas de test existants, puis mettre à jour les assertions, les variables ou les processeurs après avoir relu la structure complète. Cela réduit le risque de construire un grand scénario de manière incorrecte en une seule passe.
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detailDéplacer et reproduire les ressources du projet
La CLI mise à niveau améliore également les workflows d'importation et d'exportation pour les données natives d'Apidog. C'est utile pour la migration de projets, la reproduction d'environnements clients, la copie de configurations de tests, ou le déplacement d'APIs, de schémas, de cas de test et de scénarios entre projets.
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.jsonMaintenir les portes de qualité CI
Les nouvelles capacités prêtes pour les Agents ne remplacent pas la CI. Elles la complètent. Les équipes peuvent toujours utiliser apidog run comme point d'entrée principal pour l'exécution automatisée des tests et les rapports.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reportsPour commencer
Si vous avez déjà la CLI Apidog installée, vérifiez d'abord votre version actuelle :
apidog -vSi la version de votre CLI Apidog est antérieure à 2.2.5, mettez à jour la CLI avant d'utiliser les nouvelles fonctionnalités. Ce numéro de version fait référence à la CLI Apidog, et non à l'application Apidog.
Vous pouvez demander à l'Agent IA que vous utilisez d'installer la CLI Apidog et les Compétences complémentaires en copiant cette invite :
Lisez les instructions et aidez-moi à installer la CLI Apidog :
https://apidog.com/apidog-cli-installation-guide.mdSi vous préférez l'installer ou la mettre à jour manuellement, exécutez :
npm install -g apidog-cli@latestPour la référence complète des commandes, consultez les Options de la CLI Apidog.
Essayez votre première tâche d'Agent
Une fois la CLI et les Compétences installées, la manière la plus simple de commencer est de confier à votre Agent une petite tâche d'API à faible risque. Par exemple, demandez-lui de créer un simple point d'accès de vérification de santé (GET /health) dans un projet Apidog, puis de le relire 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éé.Cela offre aux nouveaux utilisateurs un point de départ concret : l'Agent vérifie la configuration, demande avant d'écrire dans un projet, crée une petite définition d'API et confirme le résultat sauvegardé.
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. Les équipes peuvent utiliser apidog run dans les pipelines CI pour exécuter des tests d'API, générer des rapports et maintenir des portes de qualité automatisées dans leurs workflows de test.
Comment la CLI Apidog aide-t-elle les Agents IA ?
La CLI Apidog offre aux Agents IA un moyen structuré de lire les informations d'API, de générer ou de mettre à jour des ressources de test, de valider les modifications, de les écrire dans Apidog, de relire le résultat et d'exécuter des tests pour vérification.
Qu'est-ce que cli-schema dans la CLI Apidog ?
cli-schema aide à valider des fichiers JSON complexes avant qu'ils ne soient écrits 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 fois la CLI et les Compétences complémentaires, ou l'installer manuellement avec npm install -g apidog-cli@latest.