# api-docs

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

- субагент · `type=agent` · Claude Code, Codex, Cursor · ★ 850 у репозитория
- Автор: Claude Code
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/ruvnet/agentic-flow/tree/HEAD/agentic-flow/.claude/agents/documentation/docs-api-openapi.md
- Обновлён: 2026-10-26
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/agents/api-docs

## Что делает

\`api-docs` автоматизирует описание контрактов REST API. Он ищет файлы маршрутов вроде `*.route.js` или `*.controller.js`, считывает параметры запросов и собирает итоговый файл `openapi.yaml`. Субагент работает только с путями `docs/`, `api/`, `openapi/` и `swagger/`, не затрагивая папки со скрытыми секретами или `node_modules/`.

Внутри действуют строгие ограничения среды. Агенту отключили вызов `Bash`, поиск `WebSearch` и запуск фоновых задач, оставив лишь чтение и запись локальных файлов. Без установленного пакета `claude-flow` хуки сохранения шаблонов будут завершаться сбоем. При смене версий спецификации субагент обязательно запрашивает подтверждение разработчика.

## Установка

### Claude Code (родная платформа)

**Вручную: положить файлы**
- Файл: `.claude/agents/docs-api-openapi.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

### Codex

**Вручную: положить файлы**
- Файл: `.codex/agents/docs-api-openapi.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/agents/docs-api-openapi.md` — Cursor понимает и .claude/agents/

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/ruvnet/agentic-flow/tree/HEAD/agentic-flow/.claude/agents/documentation/docs-api-openapi.md

## Когда брать
- составить спецификацию OpenAPI 3.0 по коду контроллеров
- обновить пути и схемы данных в openapi.yaml
- исключить доступ генератора документации к закрытым файлам проекта

## Примеры запросов агенту
- Создай спецификацию OpenAPI 3.0 для контроллеров пользователей в папке api
- Сверь эндпоинты в routes.js и актуализируй openapi.yaml

## Похожие
- [api-docs-generator](https://affpapa.org/nevibecode/skills/api-docs-generator.md) — скилл · 411 установок
- [adding-api-docs](https://affpapa.org/nevibecode/skills/adding-api-docs.md) — скилл · 455 установок
- [generate-swagger-docs](https://affpapa.org/nevibecode/skills/generate-swagger-docs.md) — скилл · 260 установок
- [generate-api-documentation](https://affpapa.org/nevibecode/commands/generate-api-documentation.md) — команда · 1849 установок
- [api-documenter](https://affpapa.org/nevibecode/skills/api-documenter.md) — скилл · 727 установок
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/secondsky-api-reference-documentation.md) — скилл · 472 установки

Из того же набора: [ruvnet/agentic-flow](https://affpapa.org/nevibecode/by/ruvnet/agentic-flow.md) — 76 карточек

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
