Agent für API-Dokumentation und Funktionstests
Bei diesem Projekt handelt es sich um eine Sammlung von Agenten, die zusammenarbeiten, um die Dokumentation und Funktionstests einer API zu schreiben.
Hier ist der Arbeitsablauf:
- ExtractEntrypointsAgent: Liest eine Datei und extrahiert den Code aller API-Routen-Einstiegspunkte
- für jeden Einstiegspunkt:
– WalkCallStackAgent: Ruft alle an der API-Route beteiligten Funktionen ab
-- DocumentationAgent: API-Dokumentation gemäß dem Code der Funktionen schreiben
– WriteTestsAgent: Lesen Sie die Dokumentation einer API-Route und listen Sie alle möglichen Testfälle auf
-- für jeden Testfall:
--- Beschreiben Sie, was zum Testen des aktuellen Falls erforderlich wäre (Aufbau, Abbau, Test, Matcher usw.)
--- Verwenden Sie die Testbeschreibung, die Routendokumentation und das Feedback des Jest-Läufers (falls vorhanden), um den Code zu schreiben
--- Führen Sie den Code aus
--- (wiederholen, bis alle Tests bestanden sind)
Der WriteTestsAgent verwendet eine Kette von 2 Eingabeaufforderungen.
- Die erste Eingabeaufforderung wird verwendet, um das LLM auf das Schreiben der erwarteten Spezifikationen für jeden Testfall zu konzentrieren
- Die zweite Eingabeaufforderung konzentriert die LLM-Aufmerksamkeit auf das Schreiben und Korrigieren des entsprechenden Testcodes (sie analysiert die Fehlermeldung vom Jest-Runner, um den Code iterativ zu korrigieren).
Beispiel
Der in „examples/fastify/doc“ und „examples/fastify/tests“ enthaltene Code wurde von den Agenten generiert.
Um es selbst zu versuchen, führen Sie npx ts-node run.ts aus und haben Sie etwas Geduld
