Agente de Documentación API y Pruebas Funcionales
Este proyecto es una colección de agentes que trabajan juntos para escribir la documentación y las pruebas funcionales de una API.
Aquí está el flujo de trabajo:
- ExtractEntrypointsAgent: lee un archivo y extrae el código de todos los puntos de entrada de las rutas API
- para cada punto de entrada:
-- WalkCallStackAgent: recupera todas las funciones involucradas en la ruta API
-- DocumentationAgent: escribe documentación API según el código de las funciones.
-- WriteTestsAgent: lee la documentación de una ruta API y enumera todos los casos de prueba posibles
-- para cada caso de prueba:
--- describir lo que se necesitaría para probar el caso actual (configuración, desmontaje, prueba, comparadores, etc.)
--- use la descripción de la prueba, la documentación de la ruta y los comentarios de Jest runner (si los hay) para escribir el código
--- ejecuta el código
--- (repetir hasta que pasen todas las pruebas)
WriteTestsAgent utiliza una cadena de 2 mensajes.
- el primer mensaje se utiliza para centrar el LLM en escribir las especificaciones esperadas para cada caso de prueba.
- el segundo mensaje centra la atención del LLM en escribir y corregir el código de prueba correspondiente (analiza el mensaje de error del Jest runner para corregir el código de forma iterativa)
Ejemplo
El código presente en ejemplos/fastify/doc y ejemplos/fastify/tests ha sido generado por los agentes.
Para probarlo usted mismo, ejecute npx ts-node run.ts y tenga paciencia
