DEV Community на русском
Подписаться
Я создал навык для Claude, который занимается обратной разработкой недокументированных API
Автор присоединился к новой команде и сразу же столкнулся с устаревшей документацией API, что заставило его вручную искать маршруты в кодовой базе. Это четырехчасовое испытание подчеркнуло распространенную проблему отсутствия или неточности документации во многих средах разработки. Для решения этой проблемы автор разработал API Archaeologist, навык Claude Code / Codex CLI, предназначенный для обратного инжиниринга API-слоев непосредственно из исходного кода.Этот инструмент автоматически обнаруживает различные API-элементы, включая внутренние конечные точки (REST, GraphQL, gRPC, WebSockets), внешние интеграции, потоки аутентификации и потенциальные пробелы в безопасности, такие как неаутентифицированные маршруты. API Archaeologist генерирует два ключевых выходных файла: API_DISCOVERY.md, подробный каталог с диаграммами Mermaid, и openapi-draft.yaml, предварительную спецификацию OpenAPI. В отличие от инструментов, которые полагаются на существующие аннотации или спецификации, API Archaeologist анализирует фактический исходный код, что делает его идеальным для устаревших систем, стартапов или проектов с быстрой разработкой.Навык работает путем чтения файла SKILL.md, который инструктирует Claude Code отслеживать определения маршрутов, обработчики, промежуточное ПО и вызовы базы данных, сопоставляя аутентификацию и идентифицируя внешние вызовы API. Установка включает в себя создание каталога для навыка и загрузку его файла SKILL.md для Claude Code или Codex CLI. Затем пользователи переходят в свой репозиторий бэкенда и выполняют простую команду для генерации отчетов.Автор подчеркивает, что основным выводом стало огромное количество ценной информации, уже встроенной в кодовую базу, которая нуждается только в извлечении и связывании. Хотя выходные данные OpenAPI являются черновиком, а динамическая маршрутизация может создавать проблемы, инструмент направлен на оптимизацию документации API. Будущие планы включают сопоставление потребителей API на стороне фронтенда, экспорт коллекции Postman и интеграцию CI/CD. API Archaeologist предлагает решение для команд, испытывающих трудности с устаревшей или отсутствующей документацией API, путем прямой интерпретации кода.