К основному содержанию
субагент CX Codex

api-docs — субагент для Claude Code: что делает и как установить

Субагент api-docs для Claude Code, который анализирует эндпоинты в коде и составляет спецификацию OpenAPI 3.0 в YAML или JSON.

лицензия не указана ★ 850 обновлён 2026-10-26

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/agents/docs-api-openapi.md
Открыть на GitHub

Что делает 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 или по @-упоминанию

По шагам, с командами для каждой платформы: Субагенты 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 отключён в настройках субагента. Для работы ему требуются только чтение и редактирование локальных файлов.

Похожие субагенты

Все субагенты по теме «Тексты и документация» →
api-docs-generator patricio0312rev Скилл api-docs-generator помогает составить спецификацию OpenAPI и развернуть интерактивную документацию API по кодовой базе. Пригодится при описании эндпоинтов, схем данных и подготовке клиентских SDK. CX Codex +1 411установок adding-api-docs spencerpauly Скилл adding-api-docs собирает OpenAPI/Swagger-описание вашего API: схемы эндпоинтов, типы запросов и ответов, интерактивную страницу документации. CX Codex +1 455установок generate-swagger-docs qodex-ai Скилл generate-swagger-docs для Claude Code сканирует кодовую базу, находит REST-эндпоинты и создаёт спецификацию OpenAPI и интерактивную HTML-документацию. Документирует API. CX Codex +1 260установок generate-api-documentation davila7 Команда generate-api-documentation анализирует код эндпоинтов, находит аннотации и генерирует спецификации OpenAPI, Swagger UI или Redoc. Помогает настроить сборку документации API и шаги в CI/CD. CX Codex +1 1 849установок api-documenter zhaono1 Скилл api-documenter для Claude Code: описывает REST и GraphQL API в формате OpenAPI/Swagger. Превращает россыпь эндпоинтов в читаемую спецификацию. CX Codex +1 727установок api-reference-documentation secondsky Скилл api-reference-documentation для Claude Code и других платформ собирает справочник по REST API из спецификации OpenAPI: эндпоинты, авторизация, примеры запросов и ответов. Закрывает задачи developer portal и SDK-референса. CX Codex +1 472установок

Из того же набора76

Весь набор →
workflow-automation Команда workflow-automation связывает агентные рои с GitHub Actions для настройки умных CI/CD-пайплайнов, отбора тестов и автоматического анализа сбоев. CX Codex +1 ★ 850звёзд репо trading-predictor Субагент trading-predictor для Claude, который оценивает, насколько расчёт опережает доставку рыночных данных, и на этом запасе строит прогноз и оценку риска. CX Codex ★ 850звёзд репо backend-dev Субагент backend-dev разрабатывает backend API и учитывает прошлые решения по API. Он срабатывает на задачи об endpoint, маршрутах и REST или GraphQL. CX Codex ★ 850звёзд репо project-board-sync Команда project-board-sync связывает задачи роя агентов с карточками GitHub Projects: статусы, метки агентов и приоритеты переезжают в нужные колонки. CX Codex +1 ★ 850звёзд репо examples Команда examples показывает сценарии парного программирования: от JWT-аутентификации и исправления утечек памяти до TDD, рефакторинга и React. CX Codex +1 ★ 850звёзд репо base-template-generator Субагент base-template-generator для Claude Code создаёт стартовый набор файлов для нового компонента, эндпоинта или проекта: структуру, типы и тесты. CX Codex ★ 850звёзд репо planner Субагент planner декомпозирует задачи, строит критический путь и распределяет работу в Claude Code с учётом прошлого опыта. CX Codex ★ 850звёзд репо researcher Субагент researcher для Claude Code исследует кодовую базу, выявляет повторяющиеся решения и связи между модулями. Собирает выводы о структуре проекта и документации. CX Codex ★ 850звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой