Агент документации API и функциональных тестов
Этот проект представляет собой группу агентов, работающих вместе над написанием документации и функциональных тестов API.
Вот рабочий процесс:
- ExtractEntrypointsAgent: прочитайте файл и извлеките код всех точек входа маршрутов API.
- для каждой точки входа:
-- WalkCallStackAgent: получить все функции, задействованные в маршруте API.
-- DocumentationAgent: писать документацию по API в соответствии с кодом функций.
-- WriteTestsAgent: прочтите документацию по маршруту API и перечислите все возможные тестовые примеры.
-- для каждого тестового примера:
--- опишите, что потребуется для тестирования текущего случая (настройка, демонтаж, тестирование, сопоставление и т. д.)
--- используйте описание теста, документацию по маршруту и отзывы от Jest runner (если таковые имеются) для написания кода.
--- запустите код
--- (повторяйте, пока все тесты не пройдут)
WriteTestsAgent использует цепочку из двух приглашений.
- первое приглашение используется для того, чтобы сосредоточить LLM на написании ожидаемых спецификаций для каждого тестового примера.
- вторая подсказка сосредотачивает внимание LLM на написании и исправлении соответствующего тестового кода (он анализирует сообщение об ошибке от бегуна Jest, чтобы итеративно исправить код)
Пример
Код, присутствующий в примерах/fastify/doc и example/fastify/tests, был создан агентами.
Чтобы попробовать себя, запустите npx ts-node run.ts
и наберитесь терпения.