Dies ist eine 10-teilige Serie, die beschreibt, wie Apidog die Apidog CLI, ein Befehlszeilentool für API-Tests und das API-Lebenszyklusmanagement, entwickelt hat. Lesen Sie die Beiträge der Reihe nach oder springen Sie zu einem beliebigen Beitrag, der Sie interessiert:
| Titel | Fokus | |
|---|---|---|
| 1 | Wir haben 126 MCP-Tools entwickelt. Aber es ist nicht die beste Lösung für Agenten | Problemerkennung |
| 2 | Warum wir die brandneue Apidog CLI entwickelt haben | Architekturentwicklung |
| 3 | Die goldene Regel: CLI liefert Fakten, Modell agiert auf Fakten | Kernphilosophie |
| 4 | agentHints: CLIs beibringen, mit Agenten zu kommunizieren |
Strukturierte Ausgabe |
| 5 | SKILL: Operative Erfahrung als Code ausliefern | Operative Erfahrung |
| 6 | Die Zahlen lügen nicht: 30 % weniger Tool-Aufrufe, 25 % weniger Tokens | Quantitative Ergebnisse |
| 7 | Von PRD zum Testzyklus: Ein vollständiger Agenten-Workflow mit Apidog CLI | Praktisches Tutorial |
| 8 | Warum CI/CD-Kompatibilität für Agenten-Tools nicht verhandelbar ist | DevOps-Perspektive |
| 9 | AI Branch: Sicherere Projektänderungen mit KI-Agenten | Sicherheitsebene |
| 10 | Spec-First war gestern. Willkommen bei Skill-First. | Vision & Zukunft |
Agentenfreundlichkeit muss auf CI/CD-Freundlichkeit aufbauen. Erfahren Sie, warum apidog run sowohl CI-Pipelines als auch KI-Agenten unterstützt – und warum dieser doppelte Zweck wichtig ist.
Das doppelte Publikum
Beim Erstellen von Agenten-Tools ist es leicht, sich ausschließlich auf die Konversationserfahrung zu konzentrieren.
Die Apidog CLI hat ein wichtiges Serviceziel, das nicht vergessen werden darf: CI/CD.
| Ursprüngliches Publikum | Neues Publikum |
|---|---|
| CI/CD-Pipelines | KI-Agenten |
| Externe Planungssysteme | Konversationsbasierte Workflows |
| Skripte und Automatisierung | Benutzergesteuerte Aufgaben |
Viele Teams verwenden Apidog bereits in Pipelines, um:
- Automatisierte API-Tests auszuführen
- Berichte zu generieren
- Qualitäts-Gates aufrechtzuerhalten
Dieses Szenario erfordert:
| Anforderung | Warum |
|---|---|
| Stabile Ausgabe | Skripte parsen vorhersehbare Ergebnisse |
| Skriptfähige Befehle | Automatisierte Ausführung |
| Eindeutige Exit-Codes | Pipeline-Bestanden/Fehlgeschlagen-Entscheidungen |
| Konfigurierbare Parameter | Umgebungsspezifische Ausführungen |
Die Automatisierung darf nicht unterbrochen werden, nur um Agenten unterzubringen.
Das Hauptprinzip
Agentenfreundlichkeit muss auf CI/CD-Freundlichkeit aufbauen.
Wir haben kein Protokoll neu erfunden, das nur von KI verwendet werden kann. Wir haben strukturierte Ausgaben, Schema-Validierung und Anleitungen für die nächsten Schritte hinzugefügt, die Agenten benötigen, und das auf einer Form, die bereits von Ingenieursystemen validiert wurde.
Gute CLI-Engineering-Tools im Zeitalter der Agenten sollten in der Lage sein, Folgendes zu bedienen:
| Verbraucher | Ihre Bedürfnisse |
|---|---|
| Menschen | Lesbare Ausgabe, Hilfetext, interaktive Funktionen |
| Skripte | Stabile Ausgabe, skriptfähige Befehle |
| CI-Pipelines | Exit-Codes, Berichtsdateien, konfigurierbare Ausführungen |
| KI-Agenten | Strukturierte Ergebnisse, Validierung, Anleitung |
apidog run: Der Kernbefehl
Die Grundlage bleibt:
apidog run --project <projectId> \
--test-scenario <scenarioId> \
--environment <environmentId> \
-r "cli,html,junit" \
--out-dir ./apidog-reportsDieser Befehl bedient alle vier Verbraucher.
Worauf es CI ankommt
| CI-Anforderung | CLI-Funktion |
|---|---|
| Exit-Codes | 0 für Erfolg, 1 für Fehler – Pipeline-Entscheidung |
| Berichtsdateien | HTML-, JUnit-, JSON-Formate im --out-dir |
| Stabile Parameter | Konsistente Optionen über Versionen hinweg |
| Konfigurierbare Ausführungen | Iterationen (-n), Verzögerungen (--delay-request), Umgebungen (-e) |
Beispiel für die CI-Nutzung:
# GitHub Actions
- name: Run API Tests
run: |
apidog run --project $PROJECT_ID \
--test-scenario $SCENARIO_ID \
--environment $ENV_ID \
-r "junit" \
--out-dir ./reports
env:
PROJECT_ID: ${{ secrets.APIDOG_PROJECT_ID }}
SCENARIO_ID: ${{ secrets.APIDOG_SCENARIO_ID }}
ENV_ID: production
- name: Publish Test Report
uses: mikepenz/action-junit-report@v3
with:
report_paths: './reports/junit.xml'Pipeline liest Exit-Code → bestanden oder fehlgeschlagen → veröffentlicht Bericht.
Worauf es Agenten ankommt
| Agenten-Anforderung | CLI-Funktion |
|---|---|
| Strukturierte Ergebnisse | JSON-Ausgabeformat mit data-Objekt |
| Fehlerursachen | Spezifische Fehlerdetails im error-Objekt |
| Vorschläge für nächste Schritte | agentHints mit nextSteps-Array |
| Validierung | cli-schema validate vor Schreibvorgängen |
Beispiel für die Agenten-Nutzung:
{
"success": true,
"stats": {
"total": 10,
"passed": 8,
"failed": 2
},
"failures": [
{
"step": "Payment processing",
"error": "Assertion failed: status != 'success'",
"response": {...}
}
],
"agentHints": {
"summary": "2 tests failed. Review failure details.",
"nextSteps": [
"Debug the Payment processing step failure.",
"Check assertion: expected status 'success'.",
"Update test case or endpoint after fixing."
]
}
}Agent parst JSON → versteht Fehler → folgt den nächsten Schritten.
Derselbe Befehl, verschiedene Verbraucher
apidog run --project <projectId> --out-dir ./apidog-reports
| Verbraucher | Was sie extrahieren |
|---|---|
| CI-Pipeline | Exit-Code (0/1), Speicherort der Berichtsdatei |
| Agent | JSON-Ausgabe, agentHints, Fehlerdetails |
| Mensch | Konsolenausgabe, HTML-Berichtslink |
| Skript | Stdout/stderr, konfigurierbares Format |
Ein Befehl für alle.
Integrationspunkte
Die Apidog CLI unterstützt die Integration mit:
| CI-Tool | Integration |
|---|---|
| Jenkins | Pipeline-Schritte, Berichtsveröffentlichung |
| GitLab CI | YAML-Konfiguration, Artefakte |
| GitHub Actions | Workflow-Schritte, Geheimnisverwaltung |
| CircleCI | Orbs, Workflow-Konfiguration |
| Azure DevOps | Pipeline-Aufgaben, Testergebnisse |
Alle Integrationen nutzen dieselbe apidog run-Grundlage.
Quality Gate vs. Verifizierung
| Anwendungsfall | Bedeutung |
|---|---|
| CI-Qualitäts-Gate | Bestanden/Fehlgeschlagen bestimmt den Pipeline-Fortschritt |
| Agenten-Verifizierung | Ausführung nach Änderungen zur Bestätigung der Korrektheit |
Derselbe Befehl, anderer Kontext:
| Kontext | Wann verwendet | Zweck |
|---|---|---|
| CI | Nach Code-Push | Verhindern, dass fehlerhafter Code bereitgestellt wird |
| Agent | Nach Testerstellung | Bestätigen, dass die Arbeit des Agenten korrekt ist |
Das Gründungsprinzip
Alles, was wir in dieser Serie beschrieben haben – cli-schema, agentHints, SKILL – baut auf dieser Grundlage auf:
┌─────────────────────────────────────────┐
│ Agentenfunktionen │
│ (cli-schema, agentHints, SKILL) │
├─────────────────────────────────────────┤
│ CI/CD-Grundlage │
│ (apidog run, Exit-Codes, Berichte) │
├─────────────────────────────────────────┤
│ Core-CLI │
│ (Befehle, Parameter, Ausführung) │
└─────────────────────────────────────────┘Agentenfunktionen ersetzen keine CI-Funktionen. Sie erweitern sie.
Was kommt als Nächstes
Wir haben das Gesamtbild behandelt – von der Problemerkennung über praktische Workflows bis hin zu grundlegenden Prinzipien.
Nun gibt es noch ein weiteres kritisches Element: Sicherheit.
Wenn Agenten Projektressourcen ändern, wie verhindern Sie, dass sie den Hauptzweig direkt beeinflussen?
In Teil 9, AI Branch: Sicherere Projektänderungen mit KI-Agenten, werden wir untersuchen, wie AI Branch eine isolierte Bearbeitungsumgebung bietet – Änderungen bleiben in einem separaten Zweig, bis sie von Menschen überprüft werden, wodurch eine Sicherheitsebene für Agenten-gesteuerte Änderungen geschaffen wird.
Wichtige Erkenntnisse
- CI/CD-Kompatibilität ist die Grundlage, nicht optional
- Agentenfreundlichkeit baut auf CI-Freundlichkeit auf
- Derselbe Befehl (
apidog run) dient CI, Agenten, Menschen, Skripten - CI benötigt: Exit-Codes, Berichte, stabile Parameter
- Agenten benötigen: strukturierte Ausgabe, Fehlerdetails, nächste Schritte
- Qualitäts-Gate (CI) + Verifizierung (Agent) = doppelter Zweck
Laden Sie Apidog herunter, um APIs in einem einzigen Arbeitsbereich zu entwerfen, zu simulieren, zu testen und zu dokumentieren. Erfahren Sie mehr über die Apidog CLI für Befehlszeilen-API-Tests, CI-Automatisierung und KI-Agenten-Workflows.
