Der Agentenmodus von GitHub Copilot ist ein Kreislauf: Er bearbeitet Dateien, führt Terminalbefehle aus, liest die Ausgabe und entscheidet, was als Nächstes zu tun ist. Warum sind Ihre API-Tests nicht in diesem Kreislauf? Sie sitzen in Apidog hinter einer GUI und werden ausgeführt, wenn sich jemand daran erinnert, darauf zu klicken. Copilot berührt sie nie.
Die Lösung ist eine Konfigurationsdatei. Die Apidog CLI ist ein npm-Paket, apidog-cli, das die in Apidog erstellten Testszenarien direkt aus einem Terminal ausführt. Sobald die CLI installiert ist und Copilot weiß, dass sie existiert, führt der Agentenmodus ein Apidog-Szenario auf dieselbe Weise aus, wie er Ihre Unit-Tests ausführt: Befehl abfeuern, Exit-Code lesen, Code reparieren, wenn er rot ist.
Wenn Sie die CLI noch nicht installiert haben, tun Sie dies zuerst. Wie man die Apidog CLI mit einem KI-Code-Agenten installiert führt durch die npm-Installation, das Login und den ersten Lauf, wobei ein Agent die Eingaben vornimmt. Dieser Artikel geht davon aus, dass apidog --version eine Nummer ausgibt und Ihr Apidog-Konto authentifiziert ist.
Um welchen Copilot es hier geht
Copilot besteht aus mehreren Produkten, und der Name überschneidet sich auf verwirrende Weise. Dieser Artikel handelt von den Oberflächen, die Shell-Befehle ausführen können.
Die wichtigste ist der Agentenmodus in VS Code. Sie öffnen die Copilot Chat-Ansicht, stellen das Modus-Dropdown auf Agent um, und er kann mehrere Dateien bearbeiten, Terminalbefehle ausführen und iterieren, bis die Aufgabe erledigt ist. Wenn er einen Befehl ausführen möchte, zeigt er Ihnen den Befehl an und bittet um Bestätigung, bevor er ihn ausführt. Dieser Bestätigungsschritt ist genau der Ort, an den apidog run passt.
Zwei verwandte Oberflächen sind erwähnenswert, damit Sie wissen, in welcher Sie sich befinden. Der Copilot Coding Agent läuft asynchron in GitHub Actions, nachdem Sie ihm ein Issue zugewiesen haben; er erstellt einen Pull Request, anstatt in Ihrem Editor zu arbeiten. Die Copilot CLI ist ein separater Terminal-Client. Beide können Befehle ausführen, aber dieser Artikel konzentriert sich auf den Agentenmodus in VS Code, da Sie dort beim Codieren sitzen und der Bearbeiten-Testen-Beheben-Kreislauf am engsten ist. Die folgende Einrichtung funktioniert auch für den Coding Agent, der dieselbe Anweisungsdatei liest. Für eine umfassendere Übersicht darüber, was sich geändert hat, als Copilot agentenhaft wurde, lesen Sie GitHub Copilots neuen Code-Agenten.
Die Unterscheidung ist wichtig, denn Copilot hat seine eigene Methode, Projektregeln zu lernen, und dieser Mechanismus verwandelt ein einmaliges „Führe meine Tests aus“ in etwas, das Copilot von selbst anstrebt. Dieser Mechanismus ist eine benutzerdefinierte Anweisungsdatei.
Schritt 1: Fügen Sie die Apidog-Regeln zur Anweisungsdatei von Copilot hinzu
Copilot liest benutzerdefinierte Repository-Anweisungen aus einer einzigen Datei: .github/copilot-instructions.md im Stammverzeichnis Ihres Repositorys. Der Agentenmodus, Copilot Chat, die Codeüberprüfung und der Coding Agent laden sie alle automatisch, gemäß den GitHub-Dokumenten zu benutzerdefinierten Repository-Anweisungen. Stellen Sie es sich wie CLAUDE.md für Claude Code oder AGENTS.md für Codex vor: eine einfache Markdown-Datei mit Projektanweisungen, die Copilot vor Beginn seiner Arbeit in den Kontext zieht.
Erstellen Sie die Datei und fügen Sie einen kurzen Apidog-Block hinzu:
## API-Tests mit der Apidog CLI
Wenn Sie einen API-Endpunkt ändern, verifizieren Sie ihn mit der Apidog CLI, bevor Sie die Aufgabe als erledigt erklären. Führen Sie aus:
apidog run -t 812345 -e 671234 -r cli
- `apidog run` beendet sich mit 0, wenn jede Behauptung erfolgreich ist, und mit einem Wert ungleich 0 bei einem Fehler. Behandeln Sie einen Exit-Code ungleich 0 als fehlgeschlagenen Test, auch wenn der Zusammenfassungstext in Ordnung aussieht.
- Die Maschine ist bereits über `apidog login` authentifiziert. Fügen Sie KEIN `--access-token`-Flag hinzu und legen Sie niemals ein Token in diese Datei.
- Wenn Sie einen "unbekannte Option"-Fehler erhalten, führen Sie `apidog run --help` aus und verwenden Sie die tatsächlichen Flags. Raten Sie nicht.
Ersetzen Sie die Werte für -t und -e durch Ihre echten Szenario- und Umgebungs-IDs aus dem nächsten Schritt.
Schreiben Sie es in die Anweisungsdatei, anstatt es im Chat zu erwähnen, da eine im Chat eingegebene Szenario-ID nach Beendigung der Sitzung verloren ist. Eine in .github/copilot-instructions.md ist für jeden Teamkollegen, jede Agentenmodus-Sitzung und jeden Pull Request, den der Coding Agent von nun an öffnet, verfügbar. Wenn die Regel nur für bestimmte Dateien gelten soll, unterstützt GitHub auch pfadspezifische Anweisungen in .github/instructions/NAME.instructions.md, aber eine einzelne repo-weite Datei ist hier ausreichend.
Schritt 2: Holen Sie den Befehl von Apidog
Sie müssen den Befehl apidog run nicht manuell schreiben. Apidog generiert ihn für Sie.
Öffnen Sie das Testszenario in Apidog, gehen Sie zu dessen CI/CD-Tab und kopieren Sie den Befehl. Er wird vollständig mit der korrekten Szenario-ID (-t), Umgebungs-ID (-e) und einem Reporter-Flag ausgegeben:
apidog run -t 812345 -e 671234 -r cli
Fügen Sie genau diese IDs in den Block in Ihrer .github/copilot-instructions.md ein. Diese IDs sind die Quelle der Wahrheit; wenn Copilot und Ihre Anweisungsdatei nicht übereinstimmen, gewinnt der CI/CD-Tab. Für die vollständige Liste der Flags und Reporter siehe die Referenz zum Befehl apidog run.
Schritt 3: Lassen Sie den Agentenmodus den Test ausführen
Öffnen Sie die Copilot Chat-Ansicht in VS Code und stellen Sie das Modus-Dropdown auf Agent um. Da der Agentenmodus .github/copilot-instructions.md beim Start lädt, weiß er bereits, dass die CLI vorhanden ist. Nehmen Sie eine Änderung vor, die Ihre API betrifft, oder fragen Sie ihn direkt:
Führen Sie das Apidog API-Testszenario aus und teilen Sie mir das Ergebnis mit.
Copilot gibt den Befehl apidog run aus Ihrer Anweisungsdatei aus. Der Agentenmodus führt Terminalbefehle nicht stillschweigend aus; er zeigt Ihnen den Befehl an und bittet Sie um Bestätigung, bevor er ihn ausführt, sodass Sie genau sehen, was ausgeführt werden soll. Genehmigen Sie ihn. Der -r cli-Reporter druckt dann ein Schritt-für-Schritt-Ergebnis und eine Zusammenfassung direkt im integrierten Terminal, wo Sie jede Anfrage und Behauptung sehen, während sie passiert.
Sie möchten zwei Dinge sehen: die Ausführung des Laufs und Copilot, der sowohl die Zusammenfassung als auch den Exit-Code meldet. Wenn Sie den Befehl einmal genehmigen, kann VS Code Ihre Wahl für diesen Befehl im Arbeitsbereich speichern, sodass spätere apidog run-Aufrufe ohne erneute Aufforderung ausgeführt werden. Ein schreibgeschütztes Testszenario gegen Staging ist genau die Art von sicherem, im Arbeitsbereich ausführbaren Befehl, den man zulassen kann.
Schritt 4: Lesen Sie den Bericht in Copilot
Wenn ein Lauf rot wird, hat der Bericht die Antwort. Mit -r cli erhält Copilot eine lesbare Aufschlüsselung im Terminal: jede Anfrage, jede Behauptung und welche mit erwartetem versus tatsächlichem Wert fehlgeschlagen ist. Die fehlerhafte Behauptung benennt das genaue Feld oder den Statuscode, was Copilot in der Regel ausreicht, um den Fehler in seiner nächsten Iteration zu beheben.
Für einen Bericht, den Sie in einem Browser öffnen oder einem Teamkollegen aushändigen können, fügen Sie den HTML-Reporter hinzu:
apidog run -t 812345 -e 671234 -r cli,html
Der html-Reporter schreibt eine eigenständige Datei nach ./apidog-reports. Behalten Sie cli in der Liste, damit Copilot weiterhin die Inline-Ausgabe erhält, die es liest, um seinen nächsten Schritt zu entscheiden. Für jedes Reporterformat, einschließlich der JUnit-Ausgabe, die CI-Dashboards parsen, siehe die vollständige Apidog CLI-Anleitung und wie man Apidog CLI-Testberichte liest.
Copilot testet innerhalb seines eigenen Kreislaufs
Der Punkt ist, was passiert, wenn Sie aufhören zu fragen und Copilot das Szenario von selbst ausführt, weil die Anweisungsdatei es ihm gesagt hat.
Stellen Sie sich vor, der Agentenmodus bearbeitet einen Handler, der eine Checkout-Antwort erstellt. Sein Kreislauf ändert sich. Er bearbeitet den Code, dann, anstatt den Sieg zu erklären, führt er Ihr Apidog-Szenario gegen Staging aus, liest den Exit-Code und handelt danach. Grün, es geht weiter. Rot, es öffnet den Bericht, liest, welche Behauptung fehlgeschlagen ist (der Statuscode, das fehlende Feld, der falsche Wert), versucht eine Korrektur und führt erneut aus. Der API-Test wird Teil desselben Bearbeiten-Testen-Beheben-Kreislaufs, den Copilot bereits für Ihre Unit-Tests durchläuft. Sie haben eine Anweisung geschrieben, und Copilot hat den Befehl in seine bestehende Arbeitsweise integriert.
Dies ist das Delegate-Then-Verify-Modell, das jeden Agenten-Workflow sicher macht. Copilot führt den Befehl aus und liest das Ergebnis; Sie erstellen weiterhin Szenarien visuell in Apidog und überprüfen stichprobenartig, ob der Agent Exit-Codes ehrlich liest. Für das breitere Muster siehe wie man KI-Agenten für API-Tests verwendet und das Apidog KI-Test-Harness.
Überprüfen Sie, ob Copilot die CLI tatsächlich ausführt
Agenten melden Erfolge, die sie nicht verdient haben, und Copilot ist da keine Ausnahme. Drei Prüfungen, in der Reihenfolge, wie oft sie Probleme aufdecken.
Bestätigen Sie zunächst, dass der Befehl überhaupt ausgeführt wurde. Der Agentenmodus zeigt die ausgeführten Befehle und deren Ausgabe inline im Terminal an. Suchen Sie nach der wörtlichen Zeile apidog run ... und einem Ergebnis darunter. Wenn Copilot sagt, dass es die Tests ausgeführt hat, Sie aber den Befehl nicht sehen, hat es etwas zusammengefasst, was es nie getan hat. Bitten Sie es, es erneut auszuführen und die Rohausgabe anzuzeigen.
Zweitens, bestätigen Sie den Exit-Code, den einzigen, der zählt:
What was the exit code of that apidog run command?
apidog run beendet sich mit 0, wenn alle Behauptungen erfolgreich sind, und mit einem Wert ungleich 0, wenn etwas fehlschlägt. Dieses einzige Verhalten ermöglicht es Copilot oder einer Pipeline, den Lauf als sauberes Gate zu behandeln. Wenn Copilots Prosa sagt „Tests bestanden“, aber der Exit-Code ungleich 0 ist, ist der Exit-Code korrekt.
Drittens, bestätigen Sie, dass das reale Szenario verwendet wurde. Wenn ein Lauf mit „Szenario nicht gefunden“ fehlschlägt, hat Copilot möglicherweise eine ID erfunden oder falsch erinnert. Überprüfen Sie die Werte -t und -e noch einmal mit Ihrer Anweisungsdatei und dem von Apidog im CI/CD-Tab generierten Befehl. Die IDs von Apidog sind die Wahrheit.
Optional: Verbinden Sie den Apidog MCP-Server
Das Ausführen von apidog run aus Ihrer Anweisungsdatei deckt das meiste ab, was Sie benötigen. Um noch einen Schritt weiter zu gehen, verbinden Sie den Apidog MCP-Server.
Der Agentenmodus in VS Code liest MCP-Server aus einer Arbeitsbereichsdatei .vscode/mcp.json im Stammverzeichnis Ihres Repositorys, gemäß den GitHub-Dokumenten zur Erweiterung von Copilot mit MCP. Der Apidog MCP-Server macht Ihre API-Spezifikationen über MCP verfügbar, sodass Copilot Ihr Schema lesen kann, während es Code schreibt, nicht erst nachträglich. Die Arbeitsteilung ist sauber: Die CLI führt die Tests aus, und MCP versorgt den Agenten mit der Spezifikation.
Wenn Sie den Copilot Coding Agent stattdessen in GitHub Actions ausführen, befindet sich seine MCP-Konfiguration an einem anderen Ort. Sie fügen sie als JSON unter den Repository-Einstellungen im Copilot-Bereich unter Cloud-Agent hinzu, wobei alle Geheimnisse als Actions-Geheimnisse mit dem Präfix COPILOT_MCP_ gespeichert werden. Die Datei .vscode/mcp.json ist für den Agentenmodus in Ihrem Editor gedacht.
Wenn Copilot falsch liegt
Einige Fehler treten während der Einrichtung häufig auf.
Er ignoriert die Anweisungsdatei. Wenn Copilot einen generischen Befehl oder gar keinen ausführt, wird die Datei möglicherweise nicht geladen. Stellen Sie sicher, dass sie genau .github/copilot-instructions.md heißt, sich im Verzeichnis .github im Stammverzeichnis Ihres Repositorys befindet und dass benutzerdefinierte Anweisungen in Ihren VS Code-Einstellungen aktiviert sind. Ein falscher Pfad bedeutet, dass Copilot sie nie liest.
Er übergibt trotzdem ein Zugriffstoken. Wenn Copilot versucht, --access-token hinzuzufügen, rät er von öffentlichen Beispielen. Der Block weist ihn bereits an, dies nicht zu tun, da die Maschine über apidog login authentifiziert ist. Verstärken Sie die Zeile und legen Sie niemals ein echtes Token in die Anweisungsdatei. Für das Authentifizierungsmodell siehe Apidog CLI-Authentifizierung.
Er erfindet ein Flag. Ein Fehler „unbekannte Option“ bedeutet, dass Copilot ein Flag geraten hat, das Ihre Version nicht besitzt. Sagen Sie ihm, er soll apidog run --help ausführen und das genaue Flag von dort kopieren, welches immer für Ihre installierte Version korrekt ist.
Er meldet einen Erfolg bei einem fehlgeschlagenen Lauf. Der kostspieligste Fehler, und der Grund, warum die Exit-Code-Regel sowohl in Ihrer Anweisungsdatei als auch in Ihrem Überprüfungsschritt enthalten ist. Wenn die Zusammenfassung und der Exit-Code nicht übereinstimmen, gewinnt der Exit-Code.
Vom täglichen Agenten zum getesteten Kreislauf
Das ist die Einrichtung. Installieren Sie apidog-cli einmal gemäß der Installationsanleitung, fügen Sie einen kurzen Apidog-Block zu Ihrer Repository-Datei .github/copilot-instructions.md hinzu, und Copilot weiß, wie Ihre API-Tests ausgeführt und das Ergebnis innerhalb desselben Kreislaufs gelesen werden, den er bereits zum Bearbeiten von Code verwendet. Ein defekter Endpunkt wird entdeckt, während Copilot noch an der Änderung arbeitet, nicht erst nachdem sie veröffentlicht wurde.
Ein Test hinter einer GUI wird ausgeführt, wenn ein Mensch klickt; ein Einzeiler-Befehl wird ausgeführt, wann immer Copilot es entscheidet. Sie erstellen weiterhin Szenarien visuell in Apidog, und Ihr Agent führt sie aus, wo Sie nicht zusehen. Laden Sie Apidog herunter, erstellen Sie ein Szenario, fügen Sie den Befehl apidog run in .github/copilot-instructions.md ein und beobachten Sie, wie Copilot ihn bei der nächsten Änderung aufgreift. Wenn Sie bereit sind, denselben Befehl in einer Pipeline ohne Copilot auszuführen, deckt Apidog CLI in GitHub Actions die Geheimnisse, Reporter und Exit-Code-Steuerung ab.