Apidog CLI ist seit langem der Befehlszeilen-Einstiegspunkt für die Ausführung von API-Tests von einem Terminal, einer CI-Pipeline, einem Automatisierungs-Workflow oder einem externen System.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>Dieses Fundament ist nach wie vor wichtig. Teams benötigen immer noch eine zuverlässige Methode, um API-Tests auszuführen, Berichte zu erstellen und Qualitätssicherungen in der CI aufrechtzuerhalten. Doch die API-Entwicklung verändert sich. KI-Agenten sind jetzt an API-Design, Testgenerierung, Debugging, Migration und Wartung beteiligt.
Für diese Workflows kann ein CLI nicht nur der letzte Schritt sein, der bestehende Tests ausführt. Es muss Agenten auch eine stabile Möglichkeit bieten, API-Assets zu lesen, Test-Assets zu erstellen oder zu aktualisieren, strukturierte Änderungen zu validieren, diese zurückzuschreiben und das Ergebnis zu verifizieren.
Das aktualisierte Apidog CLI behält das ursprüngliche Fundament für die Testausführung bei und erweitert es zu einer Workflow-Schicht für Entwickler, Skripte und KI-Agenten. Dieser Artikel erklärt, warum CLI in der Ära der KI-Agenten immer wichtiger wird, was sich im Apidog CLI geändert hat und wie Teams es für die API-Testautomatisierung nutzen können.
Warum CLI in der Ära der KI-Agenten wichtiger wird
Grafische Benutzeroberflächen sind für Menschen konzipiert. Sie sind visuell, flexibel und nützlich für die Erkundung. KI-Agenten hingegen arbeiten am besten mit strukturierten Befehlen, vorhersehbaren Eingaben, vorhersehbaren Ausgaben und klaren Validierungsschritten.
Hier wird das CLI wichtig. Ein CLI bietet Agenten und Skripten eine wiederholbare Schnittstelle zu denselben Ressourcen, die Entwickler in Apidog verwalten: APIs, Umgebungen, Variablen, Testfälle, Testszenarien, Testsuiten, Berichte, Import-/Exportdaten und mehr.
In der Praxis bedeutet dies, dass Apidog sowohl menschlichen Benutzern als auch automatisierten Workflows dienen kann. Menschen entwerfen, debuggen, überprüfen und kollaborieren weiterhin in der Produktoberfläche. Agenten und Automatisierung können das CLI verwenden, um kontrollierte Operationen rund um dieselben Assets durchzuführen.
Von apidog run zu vollständigen API- und Test-Workflows
Die frühere CLI-Erfahrung konzentrierte sich hauptsächlich auf die Testausführung. Das machte apidog run als CI-Qualitätssicherung nützlich, bedeutete aber auch, dass das CLI normalerweise am Ende des Workflows erschien. Das aktualisierte CLI erweitert die Abdeckung auf weitere zentrale Apidog-Ressourcen, sodass die Automatisierung früher eingreifen kann: Projektkontext lesen, Test-Assets vorbereiten, strukturierte Änderungen validieren und dann die Verifizierung durchführen.
Mit dem aktualisierten CLI können Benutzer und Agenten mit Ressourcen wie den folgenden arbeiten:
- Projekte und Projektmetadaten
- APIs und API-Definitionen
- Umgebungen und Variablen
- Testfälle
- Testszenarien
- Testsuiten
- Berichte
- Import- und Export-Workflows
- Konten, Branches, Runner und verwandte Projektressourcen
Dies ändert die Rolle des Apidog CLI. Es ist nicht mehr nur eine Möglichkeit, Tests auszuführen, nachdem alles andere erledigt ist. Es kann jetzt früher in den Entwicklungszyklus eingreifen, wo ein Agent das Projekt verstehen, Test-Assets generieren oder aktualisieren, Änderungen validieren und dann eine Verifizierung durchführen muss.
Ein sichererer Kreislauf für Agenten-gesteuertes Testen
Wenn ein KI-Agent bei der API-Entwicklung oder beim Testen hilft, besteht der riskante Teil nicht nur in der Generierung von Inhalten. Der riskante Teil besteht darin, generierte Inhalte ohne ausreichende Struktur oder Verifizierung in ein echtes Projekt zu schreiben.
Das aktualisierte CLI ermöglicht einen sichereren Kreislauf:
Dieser Kreislauf ist wichtig, da viele Apidog-Ressourcen strukturiert sind. Testfälle und Testszenarien können Anforderungsdaten, Zusicherungen, Variablenextraktion, Präprozessoren, Postprozessoren, Schrittreihenfolge, Referenzen auf Umgebungen und andere Details enthalten. Wenn ein Agent die Struktur errät, können kleine Fehler zu fehlgeschlagenen Schreibvorgängen, unvollständiger Anzeige in der Benutzeroberfläche oder Tests führen, die sich nicht wie erwartet verhalten.
Deshalb ist cli-schema ein wichtiger Bestandteil des Upgrades. Bevor eine komplexe JSON-Datei in Apidog geschrieben wird, kann ein Agent das CLI bitten zu überprüfen, ob die Felder und die Struktur dem erwarteten Schema entsprechen.
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.jsonKurz gesagt: Lassen Sie den Agenten generieren, aber lassen Sie das CLI vor dem Schreiben validieren.
Das CLI kann auch Agenten-orientierte Hinweise in der Befehlsausgabe liefern. Nachdem eine Ressource erstellt oder aktualisiert wurde, ist der nächste Schritt oft nicht „Stopp“. Ein zuverlässigerer Agent sollte die gespeicherte Ressource zurücklesen, die Struktur bestätigen und bei Bedarf Tests ausführen. Diese Hinweise helfen Agenten, den Workflow mit weniger blinden Flecken zu durchlaufen.
Skills geben Agenten operatives Urteilsvermögen
CLI-Befehle verleihen einem Agenten Ausführungsmacht. Skills verleihen einem Agenten operatives Urteilsvermögen.
Ein SKILL ist nicht nur eine Befehlsreferenz. Er ist eher eine Bedienungsanleitung, die für KI-Agenten geschrieben wurde: wann ein Befehl zu verwenden ist, welcher Befehl zuerst kommen sollte, welche Felder nicht geraten werden sollten, wann validiert werden soll, wann zurückgelesen werden soll und wann Tests ausgeführt werden sollen.
Ein zuverlässiger Agent sollte beispielsweise nicht immer ein großes Testszenario von Grund auf selbst schreiben. Ein sichererer Ansatz ist oft:
- Das Basisszenario erstellen.
- Schritte aus APIs oder bestehenden Testfällen importieren.
- Die vollständige Szenariostruktur zurücklesen.
- Zusicherungen, Variablenextraktion oder Prozessoren in kleineren Schritten aktualisieren.
- Das Szenario validieren und ausführen.
Skills machen diese Muster explizit. Sie helfen Agenten, häufige Fehler zu vermeiden, wie z.B. die Verwendung eines falschen Feldnamens, die Wahl eines falschen Enum-Wertes, das Überspringen der Schema-Validierung oder die Annahme, dass ein erfolgreicher Schreibvorgang bedeutet, dass die finale Ressource bereits korrekt ist.
Apidog bietet 8 begleitende Skills, die Agenten helfen, CLI-Befehle, Ressourcenstrukturen und Aufgaben-Workflows zu verstehen. Zusammen machen CLI und Skills Apidog praktischer für die KI-gestützte API-Entwicklung und -Tests.
Sicherere Projektänderungen mit KI-Branches
Wenn ein Agent Projektressourcen modifiziert, sind Sicherheit und Überprüfbarkeit wichtig. Aus diesem Grund kann das aktualisierte CLI auch zusammen mit KI-Branches verwendet werden.
Der Agent kann Änderungen zunächst in einem isolierten Branch vornehmen. Das Team kann die Unterschiede überprüfen, das Ergebnis bestätigen und dann in den Zielbranch zusammenführen. Dies hilft, zu verhindern, dass automatisierte Änderungen direkt den Hauptbranch oder einen gemeinsamen Kollaborationsbranch beeinflussen.
Was dies in realen Workflows ermöglicht
Der Wert des aktualisierten CLI lässt sich am einfachsten in konkreten Workflows erkennen.
Tests aus API-Definitionen generieren
Ein Agent kann API-Definitionen aus einem Projekt lesen, Testfälle generieren, den generierten JSON mit cli-schema validieren, die Testfälle in Apidog schreiben, sie zurücklesen und eine Verifizierung durchführen. Dies verwandelt die Testgenerierung von einem einmaligen Vorschlag in einen kontrollierten Workflow.
Komplexe Testszenarien pflegen
Bei mehrstufigen Szenarien kann der Agent zunächst Schritte aus APIs oder bestehenden Testfällen importieren und dann nach dem Zurücklesen der vollständigen Struktur Zusicherungen, Variablen oder Prozessoren aktualisieren. Dies reduziert das Risiko, ein großes Szenario in einem Durchgang falsch zu erstellen.
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detailProjektressourcen verschieben und reproduzieren
Das aktualisierte CLI verbessert auch die Import- und Export-Workflows für native Apidog-Daten. Dies ist nützlich für die Projektmigration, die Reproduktion von Kundenumgebungen, das Kopieren von Test-Setups oder das Verschieben von APIs, Schemas, Testfällen und Szenarien zwischen Projekten.
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.jsonCI-Qualitätssicherungen beibehalten
Die neuen, Agenten-fähigen Funktionen ersetzen CI nicht. Sie ergänzen sie. Teams können apidog run weiterhin als zentralen Einstiegspunkt für die automatisierte Testausführung und Berichterstattung verwenden.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reportsErste Schritte
Wenn Sie Apidog CLI bereits installiert haben, überprüfen Sie zuerst Ihre aktuelle Version:
apidog -vWenn Ihre **Apidog CLI-Version** älter als 2.2.5 ist, aktualisieren Sie das CLI, bevor Sie die neuen Funktionen verwenden. Diese Versionsnummer bezieht sich auf Apidog CLI, nicht auf die Apidog-App.
Sie können den von Ihnen verwendeten KI-Agenten bitten, sowohl Apidog CLI als auch die zugehörigen Skills zu installieren, indem Sie diesen Prompt kopieren:
Read the instructions and help me install Apidog CLI:
https://apidog.com/apidog-cli-installation-guide.mdWenn Sie es lieber manuell installieren oder aktualisieren möchten, führen Sie Folgendes aus:
npm install -g apidog-cli@latestDie vollständige Befehlsreferenz finden Sie unter Apidog CLI Options.
Probieren Sie Ihre erste Agentenaufgabe aus
Nachdem CLI und Skills installiert sind, beginnen Sie am einfachsten, indem Sie Ihrem Agenten eine kleine, risikoarme API-Aufgabe geben. Bitten Sie ihn beispielsweise, einen einfachen Health-Check-Endpunkt in einem Apidog-Projekt zu erstellen und diesen dann zurückzulesen, um das Ergebnis zu bestätigen.
Kopieren Sie diese Anweisung in Ihren KI-Agenten:
Use Apidog CLI to help me create my first API endpoint in Apidog. First, check my Apidog CLI setup and list the projects I can access. Ask me which project to use. After I confirm, create a simple GET /health endpoint named Health Check with a 200 response example. Validate any structured input before writing, then read the endpoint back and summarize what was created.Dies gibt neuen Benutzern einen konkreten Startpunkt: Der Agent überprüft das Setup, fragt vor dem Schreiben in ein Projekt, erstellt eine kleine API-Definition und bestätigt das gespeicherte Ergebnis.
Nächste Schritte:
- Apidog herunterladen, um APIs in einem einzigen Arbeitsbereich zu entwerfen, zu debuggen, zu testen und zu dokumentieren.
- Erfahren Sie mehr über Apidog CLI für Befehlszeilen-API-Tests, CI-Automatisierung und KI-Agenten-Workflows.
FAQ
Was ist Apidog CLI?
Apidog CLI ist ein Befehlszeilentool zum Ausführen von API-Tests, zum Arbeiten mit Apidog-Projektressourcen und zum Verbinden von Apidog-API- und Test-Assets mit Automatisierungs-Workflows.
Kann Apidog CLI API-Tests in CI ausführen?
Ja. Teams können apidog run in CI-Pipelines verwenden, um API-Tests auszuführen, Berichte zu generieren und automatisierte Qualitätssicherungen in ihren Test-Workflows beizubehalten.
Wie hilft Apidog CLI KI-Agenten?
Apidog CLI bietet KI-Agenten eine strukturierte Möglichkeit, API-Informationen zu lesen, Test-Assets zu generieren oder zu aktualisieren, Änderungen zu validieren, diese in Apidog zu schreiben, das Ergebnis zurückzulesen und Tests zur Verifizierung auszuführen.
Was ist cli-schema in Apidog CLI?
cli-schema hilft bei der Validierung komplexer JSON-Dateien, bevor sie in Apidog geschrieben werden. Dies reduziert fehlgeschlagene Schreibvorgänge, ungültige Felder und unnötige Wiederholungsschleifen, wenn Agenten Testfälle und Testszenarien erstellen oder aktualisieren.
Wie installiere ich Apidog CLI?
Sie können einen KI-Agenten bitten, der Installationsanleitung von Apidog CLI zu folgen und sowohl das CLI als auch die begleitenden Skills zu installieren, oder es manuell mit npm install -g apidog-cli@latest installieren.