Codex ist ein Kreislauf: Es bearbeitet Dateien, führt Befehle 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, zu klicken. Ihr Agent berührt sie nie.
Die Lösung ist ein Konfigurationsblock. Die Apidog CLI ist ein npm-Paket, apidog-cli, das die in Apidog erstellten Testszenarien direkt von einem Terminal ausführt. Sobald die CLI installiert ist und Codex von ihrer Existenz weiß, führt Ihr Agent ein Apidog-Szenario auf die gleiche Weise aus wie Ihre Unit-Tests: Befehl abfeuern, den Exit-Code lesen, den Code korrigieren, wenn er rot ist.
Dieser Leitfaden behandelt den Codex-spezifischen Teil, den die allgemeine Installationsanleitung überspringt: die genaue Zeile für Ihre AGENTS.md, den Prompt, den Sie Codex geben, wie es apidog run innerhalb seines eigenen Kreislaufs ausführt und wie das Ergebnis zu lesen ist.
Wenn Sie die CLI noch nicht installiert haben, tun Sie dies zuerst. So installieren Sie die Apidog CLI mit einem KI-Code-Agenten führt Sie durch die npm-Installation, den Zugriffstoken und den ersten Lauf, wobei Codex die Eingaben vornimmt. Dieser Artikel geht davon aus, dass apidog --version eine Zahl ausgibt und Ihr Apidog-Konto authentifiziert ist.
Schaltfläche
Um welches Codex es hier geht
Sowohl die OpenAI Codex CLI als auch die Codex App. Es läuft lokal, liest Ihr Repository, bearbeitet Dateien und führt Shell-Befehle in einer Sandbox aus, wobei es je nach Ihrem Berechtigungsmodus um Genehmigung bittet. Es ist nicht die alte Codex Code-Completion API. Wenn Sie codex ausführen und eine Vollbildoberfläche mit Diffs und Befehlsausgabe erhalten, sind Sie richtig. Der OpenAI Codex CLI-Leitfaden behandelt die Grundlagen.
Die Unterscheidung ist wichtig, da Codex eine eigene Methode hat, Projektregeln zu lernen, und dieser Mechanismus verwandelt ein einmaliges „Führe meine Tests aus“ in etwas, das Codex von selbst aufgreift. Dieser Mechanismus ist AGENTS.md.
Der Mechanismus: AGENTS.md, keine Chat-Erinnerung
Codex liest AGENTS.md-Dateien, bevor es seine Arbeit beginnt. Stellen Sie es sich vor wie CLAUDE.md für Claude Code: eine einfache Markdown-Datei mit Projektanweisungen, die Codex zu Beginn jeder Sitzung in den Kontext lädt. Es erstellt den Anweisungssatz, indem es von Ihrem Git-Root-Verzeichnis bis zu Ihrem aktuellen Verzeichnis geht und jede AGENTS.md von oben nach unten verkettet, sodass näher liegende Dateien bei Konflikten Vorrang haben. Es gibt auch eine globale ~/.codex/AGENTS.md. Für unsere Zwecke reicht eine Datei im Repo-Root-Verzeichnis aus.
Deshalb schreiben Sie die CLI in AGENTS.md, anstatt sie im Chat zu erwähnen. Eine in den Chat eingegebene Szenario-ID ist nach Beendigung der Sitzung verschwunden. Eine in AGENTS.md ist für jedes Teammitglied und jeden Codex-Lauf von nun an verfügbar.
Schritt 1: Geben Sie Codex den Prompt und beobachten Sie die Ausführung
Mit dem eingerichteten Block starten Sie Codex in Ihrem Repo:
Codex lädt AGENTS.md beim Start, sodass es die CLI bereits kennt. Nehmen Sie eine Änderung vor, die Ihre API betrifft, oder bitten Sie es, die Prüfung auszuführen:
Codex gibt den apidog run-Befehl aus Ihrer AGENTS.md aus. Im Standard-Auto-Modus kann es Dateien lesen, bearbeiten und Befehle im Arbeitsverzeichnis eigenständig ausführen, sodass ein einfaches apidog run normalerweise ohne Aufforderung ausgeführt wird. Der -r cli-Reporter druckt ein Schritt-für-Schritt-Ergebnis und eine Zusammenfassung direkt im Terminal, wo Sie jede Anfrage und Assertion bei ihrer Ausführung beobachten.
Sie möchten sehen, wie der Lauf ausgeführt wird und wie Codex sowohl die Zusammenfassung als auch den Exit-Code zurückmeldet. Wenn Ihr Berechtigungsmodus „Nur Lesen“ ist, pausiert Codex und fragt vor der Ausführung; genehmigen Sie es oder ändern Sie den Modus mit /permissions innerhalb der Sitzung. „Auto“ ist die vernünftige Standardeinstellung, da ein schreibgeschütztes Testszenario gegen Staging genau die Art von sicherem, In-Workspace-Befehl ist, für die dieser Modus entwickelt wurde.
Schritt 2: Codex testet im eigenen Kreislauf
Der Punkt ist, was passiert, wenn Sie nicht mehr fragen und Codex das Szenario von selbst ausführt, weil AGENTS.md es ihm gesagt hat.
Stellen Sie sich vor, Codex bearbeitet einen Handler, der eine Checkout-Antwort erstellt. Sein Kreislauf ändert sich: Es bearbeitet den Code, dann, anstatt den Sieg zu erklären, führt es 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 Assertion fehlgeschlagen ist (der Statuscode, das fehlende Feld, der falsche Wert), versucht eine Korrektur und führt es erneut aus. Der API-Test wird Teil desselben Bearbeiten-Testen-Beheben-Kreislaufs, den Codex bereits für Ihre Unit-Tests durchläuft. Sie haben eine Anweisung geschrieben und Codex hat den Befehl in seine bestehende Funktionsweise integriert.
Dies ist das Modell „delegieren und dann überprüfen“, das jeden Agenten-Workflow sicher macht. Codex führt den Befehl aus und liest das Ergebnis; Sie erstellen weiterhin Szenarien visuell in Apidog und überprüfen stichprobenartig, ob der Agent die Exit-Codes ehrlich liest. Für das umfassendere Muster siehe wie man KI-Agenten für API-Tests einsetzt und das Apidog KI-Testharness.
Überprüfen Sie, ob Codex die CLI tatsächlich ausführt
Agenten melden Erfolge, die sie nicht verdient haben, und Codex ist keine Ausnahme. Drei Überprüfungen, in der Reihenfolge ihrer Häufigkeit, Probleme zu erkennen.
Zuerst bestätigen Sie, dass der Befehl überhaupt ausgeführt wurde. Die Codex-Oberfläche zeigt die ausgeführten Befehle und deren Ausgabe direkt an. Suchen Sie nach der wörtlichen Zeile apidog run ... und einem Ergebnis darunter. Wenn Codex sagt, es habe die Tests ausgeführt, Sie den Befehl aber nicht sehen, hat es etwas zusammengefasst, das es nie getan hat. Bitten Sie es, es erneut auszuführen und die Rohausgabe anzuzeigen.
Zweitens, bestätigen Sie den Exit-Code, den, der zählt:
Wie war der Exit-Code dieses apidog run-Befehls?
apidog run beendet mit 0, wenn jede Assertion erfolgreich ist, und mit einem Wert ungleich Null, wenn etwas fehlschlägt. Dieses einzelne Verhalten ermöglicht es Codex oder einer Pipeline, den Lauf als sauberes Tor zu behandeln. Wenn der Text von Codex „Tests bestanden“ sagt, der Exit-Code aber ungleich Null ist, hat der Exit-Code Recht.
Drittens, bestätigen Sie, dass es das echte Szenario verwendet hat. Wenn ein Lauf mit „Szenario nicht gefunden“ fehlschlägt, hat Codex möglicherweise eine ID erfunden oder falsch erinnert. Überprüfen Sie die Werte für -t und -e erneut mit AGENTS.md und dem Befehl, den Apidog im CI/CD-Tab generiert hat. Die IDs in AGENTS.md sind die Wahrheit.
Den Testbericht lesen
Wenn ein Lauf fehlschlägt (rot wird), enthält der Bericht die Antwort. Mit -r cli erhält Codex eine lesbare Aufschlüsselung im Terminal: jede Anfrage, jede Assertion und welche mit erwartetem versus tatsächlichem Wert fehlgeschlagen ist. Die fehlschlagende Assertion benennt das genaue Feld oder den Statuscode, was normalerweise ausreicht, damit Codex die Lösung findet.
Für einen Bericht, den Sie in einem Browser öffnen oder einem Teamkollegen übergeben können, fügen Sie den HTML-Reporter hinzu
Der html-Reporter schreibt eine eigenständige Datei nach ./apidog-reports. Behalten Sie cli in der Liste, damit Codex weiterhin die Inline-Ausgabe erhält, die es liest, um seinen nächsten Schritt zu entscheiden. Für alle Flags und Reporter, einschließlich des JUnit-Formats, das CI-Dashboards parsen, siehe den vollständigen Apidog CLI-Leitfaden und die apidog run-Befehlsreferenz.
Zwei Wege, tiefer als Shell-Befehle zu gehen
Das Ausführen von apidog run aus AGENTS.md deckt das meiste ab, was Sie benötigen. Zwei Wege gehen weiter.
Der erste ist MCP. Codex unterstützt das Model Context Protocol, und Sie fügen Server mit codex mcp add hinzu oder indem Sie ~/.codex/config.toml mit einem [mcp_servers.NAME]-Block bearbeiten. Der Apidog MCP-Server macht Ihre API-Spezifikationen über MCP verfügbar, sodass Codex Ihr Schema lesen kann, während es Code schreibt, und nicht erst danach. Die CLI führt die Tests aus; MCP versorgt den Agenten mit der Spezifikation.
Der zweite ist codex exec. Während ein einfaches codex die interaktive Oberfläche öffnet, führt codex exec "..." Codex nicht-interaktiv aus und leitet das Ergebnis an stdout weiter, was Sie in Skripten und CI verwenden. Um apidog run in einer Pipeline ohne anwesendes Codex auszuführen, behandelt Apidog CLI in GitHub Actions die Geheimnisse, Reporter und die Exit-Code-Absicherung.
Wenn Codex Fehler macht
Einige Fehler treten während der Einrichtung häufig auf.
Es ignoriert den AGENTS.md-Block. Wenn Codex einen generischen Befehl oder gar keinen ausführt, wird der Block möglicherweise nicht geladen. Bestätigen Sie, dass die Datei genau AGENTS.md heißt und sich in Ihrem Git-Root-Verzeichnis oder einem übergeordneten Verzeichnis Ihres aktuellen Verzeichnisses befindet. Ein Tippfehler im Dateinamen bedeutet, dass Codex sie nie liest; ein Neustart der Sitzung erzwingt ein erneutes Lesen.
Es übergibt trotzdem einen Zugriffstoken. Wenn Codex versucht, --access-token hinzuzufügen, rät es von öffentlichen Beispielen. Der Block weist es bereits an, dies nicht zu tun, da der Computer über apidog login authentifiziert ist. Verstärken Sie die Zeile und legen Sie niemals einen echten Token in AGENTS.md ab.
Es erfindet ein Flag. Ein „unbekannte Option“-Fehler bedeutet, dass Codex ein Flag erraten hat, das Ihre Version nicht besitzt. Sagen Sie ihm, es solle apidog run --help ausführen und kopieren Sie das genaue Flag von dort, das immer korrekt für Ihre installierte Version ist.
Es meldet einen Erfolg bei einem fehlgeschlagenen Lauf. Der kostspieligste Fehler und der Grund, warum die Exit-Code-Regel in Ihrer AGENTS.md und Ihrem Verifizierungsschritt steht. Wenn Zusammenfassung und 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 Repo-AGENTS.md hinzu, und Codex weiß, wie es Ihre API-Tests ausführt und das Ergebnis innerhalb desselben Kreislaufs liest, den es bereits zum Bearbeiten von Code verwendet. Ein fehlerhafter Endpunkt wird erkannt, während Codex noch an der Änderung arbeitet, nicht erst, nachdem sie ausgeliefert wurde.
Ein Test hinter einer GUI wird ausgeführt, wenn ein Mensch klickt; ein einzeiliger Befehl wird ausgeführt, wann immer Codex 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 seinen apidog run-Befehl in AGENTS.md ein und beobachten Sie, wie Codex ihn bei der nächsten Änderung aufgreift.
Schaltfläche