# api-documenter

api-documenter — субагент для генерации документации API по реализации, схемам и примерам; проверяет соответствие спецификации коду.

- субагент · `type=agent` · Codex, Claude Code, Cursor · ★ 6505 у репозитория
- Автор: VoltAgent
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/VoltAgent/awesome-codex-subagents/tree/HEAD/categories/07-specialized-domains/api-documenter.toml
- Обновлён: 2026-10-05
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/agents/voltagent-api-documenter

## Что делает

api-documenter работает как надёжный инженер документации, а не сборщик чеклистов. Он отображает границы домена и рабочий процесс, отделяет подтверждённые факты от предположений, и предлагает минимальное вмешательство с ясными trade-off'ами.

Сосредоточен на фундаментальном: верность контракта между документацией и кодом, примеры на уровне endpoint'ов с успешными и ошибочными сценариями, ясность аутентификации и модели ошибок для потребителя API. Проверяет, что документированные поля и коды ошибок соответствуют текущему коду, версионирование и миграции задокументированы явно, breaking-change'ы сопровождаются путём переезда.

Возвращает точные границы анализа, первичный риск с доказательствами, минимальное безопасное изменение и трассировку валидаций. Не выдумывает недокументированное поведение API.

## Установка

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

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

### Claude Code

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

### Cursor

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/VoltAgent/awesome-codex-subagents/tree/HEAD/categories/07-specialized-domains/api-documenter.toml

## Когда брать
- убедиться, что примеры в документации совпадают с реальным поведением endpoint'ов
- выверить edge-case'ы и ошибочные сценарии в примерах
- уточнить модели аутентификации, авторизации и ошибок для разработчика
- проверить актуальность документации против текущего кода и схемы
- структурировать документацию для быстрого старта и безопасной интеграции

## Примеры запросов агенту
- Проверь, совпадают ли примеры в документации `/users` endpoint'а с тем, что возвращает реальный код
- Сгенерируй документацию для нового API, включив примеры успеха и ошибок
- Найди рассинхронизацию между схемой базы данных и документированными полями ответа

## Похожие
- [zod-validation-utilities](https://affpapa.org/nevibecode/skills/zod-validation-utilities.md) — скилл · 4100 установок
- [zod](https://affpapa.org/nevibecode/skills/bobmatnyc-zod.md) — скилл · 907 установок
- [graphql-api-development](https://affpapa.org/nevibecode/skills/graphql-api-development.md) — скилл · 449 установок
- [api-testing-observability-api-documenter](https://affpapa.org/nevibecode/agents/api-testing-observability-api-documenter.md) — субагент · ★ 42780 у репозитория
- [code-documenter](https://affpapa.org/nevibecode/skills/code-documenter.md) — скилл · 6200 установок
- [implement-graphql-api](https://affpapa.org/nevibecode/commands/buildwithclaude-community-implement-graphql-api.md) — команда · ★ 3785 у репозитория

## Другие версии с тем же именем
- [api-documenter · voltagent](https://affpapa.org/nevibecode/agents/api-documenter.md) — 6451 установка

Из того же набора: [voltagent/awesome-codex-subagents](https://affpapa.org/nevibecode/by/voltagent/awesome-codex-subagents.md) — 176 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

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