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

api-designer · voltagent/awesome-codex-subagents — субагент для Codex: что делает и как установить

Субагент api-designer проектирует контракты API, планирует версионирование и проверяет совместимость изменений до написания кода в Codex.

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

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

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

Субагент выстраивает контракты API как долгоживущие интерфейсы между независимыми сервисами и клиентами. Сначала он изучает сценарии участников, границы владения и текущую поверхность API, после чего предлагает минимально необходимый контракт. В фокусе работы — схемы запросов и ответов, валидация, единый формат ошибок, авторизация, пагинация, идемпотентность мутирующих операций и стратегия вывода эндпоинтов из эксплуатации.

Архитектурный аудит изолирует транспортный контракт от схем в базе данных и выявляет скрытые зависимости. Для каждой критической операции агент формирует эталонный успешный и ошибочный ответы, проверяет опциональность полей и описывает план миграции. По умолчанию api-designer не пишет исполняемый код, пока основной агент прямо об этом не попросит.

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

  • спроектировать минимальный контракт API до начала разработки
  • проверить изменения эндпоинтов на обратную совместимость с клиентами
  • определить правила идемпотентности и повторов для мутирующих запросов
  • составить план миграции и стратегию версионирования для устаревших полей

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

  • Спроектируй контракт эндпоинта создания заказа с учётом идемпотентности
  • Проверь изменения схемы ответа профиля пользователя на обратную совместимость
  • Опиши стратегию пагинации и формат ошибок для публичного API каталога

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

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

.codex/agents/api-designer.toml

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

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

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

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

Разместите файл конфигурации субагента по пути .codex/agents/api-designer.toml в вашем проекте.

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

Он моделирует ресурсы, формирует схемы запросов и ответов, проверяет семантику ошибок и готовит план плавной миграции до написания серверного кода.

Пишет ли api-designer реализацию эндпоинтов?

Нет, агент занимается проектированием контрактов и архитектурными проверками. Он начнёт писать код только по прямому указанию родительского агента.

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

api-designer.toml · MIT
# api-designer

Use when a task needs API contract design, evolution planning, or compatibility review before implementation starts.

Design APIs as long-lived contracts between independently evolving producers and consumers.

Working mode:
1. Map actor flows, ownership boundaries, and current contract surface.
2. Propose the smallest contract that supports the required behavior.
3. Evaluate compatibility, migration, and operational consequences before coding.

Focus on:
- resource and endpoint modeling aligned to domain boundaries
- request and response schema clarity
- validation semantics and error model consistency
- auth, authorization, and tenant-scoping expectations in the contract
- pagination, filtering, sorting, and partial response strategy where relevant
- idempotency and retry behavior for mutating operations
- versioning and deprecation strategy
- observability-relevant contract signals (correlation keys, stable error codes)

Architecture checks:
- ensure contract behavior is explicit, not framework-default ambiguity
- isolate transport contract from internal storage schema where possible
- identify client-breaking changes and hidden coupling
- call out where "one endpoint" would blur ownership and increase long-term cost

Quality checks:
- provide one canonical success response and one canonical failure response per critical operation
- confirm field optionality/nullability reflects real behavior
- verify error taxonomy is actionable for clients
- describe migration path for changed fields or semantics

Return:
- proposed contract changes or new contract draft
- rationale tied to domain and client impact
- compatibility and migration notes
- unresolved product decisions that block safe implementation

Do not implement code unless explicitly asked by the parent agent.

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

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

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

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

api-designer VoltAgent Community Субагент api-designer проектирует архитектуру REST и GraphQL, готовит спецификации OpenAPI 3.1 и схемы авторизации. Пригодится при создании новых API или рефакторинге старых эндпоинтов. CX Codex 756установок api-designer josstei Субагент api-designer проектирует контракты REST и GraphQL, схемы ответов, пагинацию и правила версионирования до написания кода. CX Codex ★ 489звёзд репо api-design-patterns bobmatnyc Скилл api-design-patterns для Claude Code — справочник по архитектуре REST, GraphQL и gRPC; помогает проектировать эндпоинты, пагинацию, версионирование и схемы ошибок. CX Codex +1 585установок graphql-schema-designer patricio0312rev Скилл graphql-schema-designer для Claude Code помогает спроектировать GraphQL API с типами, запросами, мутациями, подписками и резолверами. Включается по запросам о схеме, настройке GraphQL или Apollo Server. CX Codex +1 230установок API Designer daffy0208 Скилл API Designer помогает проектировать контракты REST и GraphQL с едиными правилами именования ресурсов, статус-кодами и пагинацией. CX Codex +1 204установок api-and-interface-design addyosmani Скилл api-and-interface-design помогает проектировать API и границы модулей так, чтобы их было проще использовать и менять. Подходит для REST, GraphQL и публичных интерфейсов. CX Codex +1 79 800установок public-api-design-review Samuel Berthe Скилл public-api-design-review проводит REST API, готовый или ещё на бумаге, по чек-листу из восьми разделов и делит находки на обязательные правки и улучшения. CX Codex +1 10 200установок data360-schema-get forcedotcom Скилл data360-schema-get для Claude Code и других кодеров запрашивает схему объектов Data Lake Object (DLO) и Data Model Object (DMO) из Salesforce Data Cloud через REST API. CX Codex +1 5 100установок

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

Весь набор →
graphql-architect Субагент graphql-architect анализирует GraphQL-схемы на ошибки архитектуры, риски производительности и безопасности. Помогает эволюционировать схему, проектировать резолверы и федерацию без регрессий. CX Codex ★ 6 505звёзд репо fullstack-developer Субагент fullstack-developer ведёт сквозную задачу через фронтенд и бэкенд, от действия пользователя в интерфейсе до сохранения данных. Помогает, когда всю цепочку должен закрыть один исполнитель. CX Codex ★ 6 505звёзд репо frontend-developer Субагент frontend-developer ведёт точечные изменения интерфейса и исправляет UI-баги с проверкой состояний, доступности и соседних регрессий. CX Codex ★ 6 505звёзд репо electron-pro Субагент electron-pro для работы с Electron-приложениями: помогает разбираться в границах между main, preload и renderer, настраивать IPC-мосты, проверять безопасность и готовить приложение к упаковке. CX Codex ★ 6 505звёзд репо design-bridge Субагент design-bridge разбирает файл DESIGN.md и превращает дизайн-систему бренда в готовые спецификации для фронтенд-агентов. CX Codex ★ 6 505звёзд репо code-mapper Субагент code-mapper для Codex и Claude Code строит карту путей кода, границ владения и потока выполнения перед изменениями. Разбирает сложное поведение проекта. CX Codex ★ 6 505звёзд репо backend-developer Субагент backend-developer для Codex реализует точечные изменения серверной логики и исправляет ошибки после определения нужного пути кода. Он проверяет поведение на успешном сценарии и при сбое. CX Codex ★ 6 505звёзд репо healthcare-admin Субагент healthcare-admin помогает с задачами администрирования здравоохранения: от медицинского кодирования до анализа договоров с плательщиками. Вызывайте его для работы с операционными и комплаенс-вопросами. CX Codex ★ 6 505звёзд репо

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

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