Dokumentasi API dan Agen Uji Fungsional
Proyek ini adalah kumpulan agen yang bekerja sama untuk menulis dokumentasi dan pengujian fungsional API.
Inilah alur kerjanya:
- ExtractEntrypointsAgent: membaca file dan mengekstrak kode semua titik masuk rute API
- untuk setiap titik masuk:
-- WalkCallStackAgent: mengambil semua fungsi yang terlibat dalam rute API
-- Agen Dokumentasi: tulis dokumentasi API sesuai dengan kode fungsinya
-- WriteTestsAgent: membaca dokumentasi rute API dan membuat daftar semua kasus pengujian yang mungkin
-- untuk setiap kasus uji:
--- jelaskan apa yang diperlukan untuk menguji kasus saat ini (penyiapan, pembongkaran, pengujian, pencocokan, dll)
--- gunakan deskripsi tes, dokumentasi rute, dan umpan balik dari Jest runner (jika ada) untuk menulis kode
--- jalankan kodenya
--- (ulangi sampai semua tes lulus)
WriteTestsAgent menggunakan rangkaian 2 prompt.
- prompt pertama digunakan untuk memfokuskan LLM pada penulisan spesifikasi yang diharapkan untuk setiap kasus uji
- prompt kedua memusatkan perhatian LLM pada penulisan dan koreksi kode pengujian yang sesuai (ini menganalisis pesan kesalahan dari Jest runner untuk memperbaiki kode secara berulang)
Contoh
Kode yang ada di example/fastify/doc dan example/fastify/tests telah dibuat oleh agen.
Untuk mencobanya sendiri, jalankan npx ts-node run.ts
dan bersabarlah