api-docs — субагент для Claude Code: что делает и как установить
Субагент api-docs для Claude Code, который анализирует эндпоинты в коде и составляет спецификацию OpenAPI 3.0 в YAML или JSON.
лицензия не указана ★ 850 обновлён 2026-10-26
.claude/agents/docs-api-openapi.mdЧто делает api-docs
api-docs автоматизирует описание контрактов REST API. Он ищет файлы маршрутов вроде *.route.js или *.controller.js, считывает параметры запросов и собирает итоговый файл openapi.yaml. Субагент работает только с путями docs/, api/, openapi/ и swagger/, не затрагивая папки со скрытыми секретами или node_modules/.
Внутри действуют строгие ограничения среды. Агенту отключили вызов Bash, поиск WebSearch и запуск фоновых задач, оставив лишь чтение и запись локальных файлов. Без установленного пакета claude-flow хуки сохранения шаблонов будут завершаться сбоем. При смене версий спецификации субагент обязательно запрашивает подтверждение разработчика.
Какие задачи решает
- составить спецификацию OpenAPI 3.0 по коду контроллеров
- обновить пути и схемы данных в openapi.yaml
- исключить доступ генератора документации к закрытым файлам проекта
Примеры запросов агенту
- Создай спецификацию OpenAPI 3.0 для контроллеров пользователей в папке api
- Сверь эндпоинты в routes.js и актуализируй openapi.yaml
Как установить api-docs
Вручную: положить файлы
.claude/agents/docs-api-openapi.mdДля всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию
Вручную: положить файлы
.codex/agents/docs-api-openapi.tomlCodex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/
Вручную: положить файлы
.cursor/agents/docs-api-openapi.mdCursor понимает и .claude/agents/
По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст
Вопросы об api-docs
Как установить api-docs в Claude Code?
Сохраните файл конфигурации субагента по пути .claude/agents/docs-api-openapi.md. Claude Code автоматически распознает его при работе в проекте.
Какие файлы разрешено менять этому агенту?
Субагент модифицирует форматы .yaml, .yml, .json и .md внутри директорий docs/, api/, openapi/ и swagger/. Изменения в других папках или файлах тяжелее 2 МБ заблокированы правилами.
Требует ли api-docs доступ к терминалу?
Инструмент Bash отключён в настройках субагента. Для работы ему требуются только чтение и редактирование локальных файлов.