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

api-documenter · voltagent/awesome-codex-subagents — субагент для Codex: документация из кода

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

MIT ★ 6 505 обновлён 2026-10-05

Установить в Codex · Вручную: положить файлы Все способы и платформы ↓
.codex/agents/api-documenter.toml
Открыть на GitHub

Что делает api-documenter

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

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

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

Какие задачи решает

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

Примеры запросов агенту

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

Как установить api-documenter

Вручную: положить файлы

.codex/agents/api-documenter.toml

Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст

Вопросы об api-documenter

Как установить api-documenter в Codex?

Добавь файл api-documenter.toml в папку .codex/agents/ вашего проекта.

Что делает api-documenter?

Генерирует и проверяет документацию API на основе реальной реализации и схем, убеждаясь, что примеры верны, модели ошибок ясны, и контракт между кодом и документацией не нарушен.

Чем api-documenter отличается от просто описания endpoint'ов?

Это не просто шаблонный текст: субагент проверяет фактическое соответствие, отделяет предположения от фактов, тестирует нормальные пути и edge-case'ы, уточняет семантику версионирования и миграции.

Исходный текст

api-documenter.toml · MIT
# api-documenter

Use when a task needs consumer-facing API documentation generated from the real implementation, schema, and examples.

Own API documentation engineering work as domain-specific reliability and decision-quality engineering, not checklist completion.

Prioritize the smallest practical recommendation or change that improves safety, correctness, and operational clarity in this domain.

Working mode:
1. Map the domain boundary and concrete workflow affected by the task.
2. Separate confirmed evidence from assumptions and domain-specific unknowns.
3. Implement or recommend the smallest coherent intervention with clear tradeoffs.
4. Validate one normal path, one failure path, and one integration edge.

Focus on:
- contract fidelity between docs and real implementation/schema behavior
- endpoint-level request/response examples that reflect actual edge cases
- authentication, authorization, and error-model clarity for consumers
- versioning/deprecation communication and migration guidance quality
- pagination, rate limit, and idempotency semantics in docs
- operational notes for retries, webhooks, and eventual-consistency behavior
- documentation structure that supports fast onboarding and safe integration

Quality checks:
- verify documented fields/status codes map to current code/schema truth
- confirm examples include one success and one failure/edge scenario
- check auth/error sections for ambiguous or unsafe consumer assumptions
- ensure breaking-change notes and migration paths are explicit
- call out endpoints requiring runtime validation for uncertain behavior

Return:
- exact domain boundary/workflow analyzed or changed
- primary risk/defect and supporting evidence
- smallest safe change/recommendation and key tradeoffs
- validations performed and remaining environment-level checks
- residual risk and prioritized next actions

Do not invent undocumented API behavior or guarantees unless explicitly requested by the parent agent.

© VoltAgent · MIT · VoltAgent/awesome-codex-subagents

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

Все субагенты по теме «Бэкенд и API» →

Сначала — api-documenter от других авторов.

api-documenter VoltAgent Community Субагент api-documenter генерирует спецификации OpenAPI 3.1, примеры запросов и интерактивные руководства для REST или GraphQL API. Пригодится при оформлении эндпоинтов и обновлении устаревшей документации. CX Codex 6 451установок zod-validation-utilities giuseppe-trisciuoglio Скилл zod-validation-utilities для Claude Code и Codex: создание переиспользуемых схем Zod v4 с полной типизацией TypeScript для валидации API-запросов, форм и конфигураций. CX Codex +1 4 100установок zod bobmatnyc Скилл по библиотеке zod: схемы один раз, а на выходе проверка данных в рантайме и типы TypeScript. Пригодится на формах и API. CX Codex +1 907установок graphql-api-development manutej Скилл graphql-api-development для Claude Code, Codex, Cursor, Copilot и Gemini CLI по построению GraphQL API: схема, типы, резолверы, мутации, подписки, аутентификация и кэширование. CX Codex +1 449установок api-testing-observability-api-documenter Seth Hobson Субагент api-testing-observability-api-documenter для Claude Code пишет документацию API: спецификации OpenAPI 3.1, интерактивные примеры, SDK и порталы для разработчиков. Описывает API, для которого ещё нет документации. CX Codex ★ 42 780звёзд репо code-documenter https://github.com/Jeffallan Скилл code-documenter создаёт и проверяет документацию к коду, API и руководства. Нужен при добавлении docstring, JSDoc или спецификации OpenAPI. CX Codex +1 6 200установок implement-graphql-api BuildWithClaude Community Команда implement-graphql-api проводит агента по шагам сборки GraphQL API: сервер, схема, типы, курсорная пагинация и корневые Query с Mutation. CX Codex +1 ★ 3 785звёзд репо

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

Весь набор →
game-developer Субагент game-developer помогает разбирать и менять игровые системы: игровой цикл, рендеринг, загрузку ассетов и состояние игрока. Подключайте его для реализации и отладки. CX Codex ★ 6 505звёзд репо fintech-engineer Субагент fintech-engineer для работы с бухгалтерскими реестрами, перевод, сверкой и соответствием нормам. Берёт на себя проверку целостности платежей, идемпотентность операций и аудит. CX Codex ★ 6 505звёзд репо embedded-systems Субагент embedded-systems помогает проектировать прошивки и низкоуровневый код с учётом таймингов, прерываний и ограничений железа. CX Codex ★ 6 505звёзд репо blockchain-developer Субагент blockchain-developer для работы со смарт-контрактами, кошельками и транзакциями. Берёт на себя архитектурные решения и проверку безопасности по жизненному циклу блокчейн-операций. CX Codex ★ 6 505звёзд репо visual-asset-generator Субагент visual-asset-generator генерирует иконки приложений, фавиконки, логотипы и OG-изображения под точные размеры проекта через MCP-сервер prompt-to-asset. CX Codex ★ 6 505звёзд репо tooling-engineer Субагент tooling-engineer помогает проектировать и проверять внутренние скрипты, автоматизацию и служебные команды. Подключайте его, когда рабочий процесс ломается на инструментах или окружении. CX Codex ★ 6 505звёзд репо slack-expert Субагент slack-expert для Codex помогает разрабатывать интеграции со Slack: ботов, обработчики событий и рабочие процессы. Он подключается к задачам, где важны интерактивность и поведение платформы. CX Codex ★ 6 505звёзд репо refactoring-specialist Субагент refactoring-specialist проводит низкорисковый структурный рефакторинг кода без изменения его поведения, улучшая читаемость и модульность. CX Codex ★ 6 505звёзд репо

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

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