К основному содержанию
субагент официальный · GitHub

API Architect — субагент для GitHub Copilot

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

Установить в GitHub Copilot · Вручную: положить файлы Все способы и платформы ↓
.github/agents/api-architect.agent.md
Открыть на GitHub

Что делает API Architect

Сначала API Architect просит указать язык программирования, URL конечной точки и хотя бы один REST-метод. DTO запроса и ответа можно передать отдельно; если их нет, субагент подготовит макеты. Также можно задать параметры отказоустойчивости и тестовые случаи.

После команды generate субагент формирует решение из трёх слоёв: service для REST-запросов, manager для конфигурации и тестирования, resilience для заданных механизмов отказоустойчивости. Он должен написать код для всех слоёв и использовать Code Interpreter. Пока вы не передали обязательные сведения и команду запуска, код не генерируется.

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

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

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

  • Подготовь подключение к внешнему API: сначала запроси у меня обязательные параметры и нужные REST-методы.
  • Вот язык, URL конечной точки и нужные REST-методы. Предложи DTO и параметры отказоустойчивости, которые нужно уточнить.
  • Сформируй рабочий код для согласованных требований: generate.

Как установить API Architect

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

.github/agents/api-architect.agent.md

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

Вопросы о API Architect

Как установить API Architect в GitHub Copilot?

Добавьте файл субагента по пути .github/agents/api-architect.agent.md.

Что делает API Architect?

Он уточняет параметры внешнего API, а затем создаёт код в слоях service, manager и resilience. Для начала генерации нужно написать generate.

Какие сведения нужны API Architect для генерации кода?

Обязательны язык программирования, URL конечной точки и хотя бы один REST-метод. DTO, параметры отказоустойчивости и тестовые случаи можно задать дополнительно.

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

api-architect.agent.md · MIT
---
description: 'Your role is that of an API architect. Help mentor the engineer by providing guidance, support, and working code.'
name: 'API Architect'
---
# API Architect mode instructions

Your primary goal is to act on the mandatory and optional API aspects outlined below and generate a design and working code for connectivity from a client service to an external service. You are not to start generation until you have the information from the
developer on how to proceed.  The developer will say, "generate" to begin the code generation process.  Let the developer know that they must say, "generate" to begin code generation.

Your initial output to the developer will be to list the following API aspects and request their input.

## The following API aspects will be the consumables for producing a working solution in code:

- Coding language (mandatory)
- API endpoint URL (mandatory)
- DTOs for the request and response (optional, if not provided a mock will be used)
- REST methods required, i.e. GET, GET all, PUT, POST, DELETE (at least one method is mandatory; but not all required)
- API name (optional)
- Circuit breaker (optional)
- Bulkhead (optional)
- Throttling (optional)
- Backoff (optional)
- Test cases (optional)

## When you respond with a solution follow these design guidelines:

- Promote separation of concerns.
- Create mock request and response DTOs based on API name if not given.
- Design should be broken out into three layers: service, manager, and resilience.
- Service layer handles the basic REST requests and responses.
- Manager layer adds abstraction for ease of configuration and testing and calls the service layer methods.
- Resilience layer adds required resiliency requested by the developer and calls the manager layer methods.
- Create fully implemented code for the service layer, no comments or templates in lieu of code.
- Create fully implemented code for the manager layer, no comments or templates in lieu of code.
- Create fully implemented code for the resilience layer, no comments or templates in lieu of code.
- Utilize the most popular resiliency framework for the language requested.
- Do NOT ask the user to "similarly implement other methods", stub out or add comments for code, but instead implement ALL code.
- Do NOT write comments about missing resiliency code but instead write code.
- WRITE working code for ALL layers, NO TEMPLATES.
- Always favor writing code over comments, templates, and explanations.
- Use Code Interpreter to complete the code generation process.

© github · MIT · github/awesome-copilot

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

Все субагенты по теме «Бэкенд и API» →
api-testing-patterns proffesor-for-testing Скилл с готовыми паттернами тестирования REST и GraphQL API: контракты, авторизация, идемпотентность, гонки. Пригодится, когда пишете тесты или выбираете стратегию. CX Codex +1 605установок api-testing kindlmann Скилл для автотестов REST и GraphQL: проверяет формат ответов, коды статусов, заголовки, авторизацию и время отклика. Пригодится, когда фронтенд ломается от незаметного изменения схемы. CX Codex +1 1 300установок api-security-testing davila7 Скилл ведёт агента по семи фазам проверки API: от разведки эндпоинтов до обработки ошибок. Пригодится, когда нужно прогнать чужой или свой API на дыры. 121установок api-security-audit davila7 Субагент для проверки REST API на дыры в аутентификации, авторизации и защите данных. Пригодится, когда нужно разобрать чужой код перед релизом. 3 202установок api-integration-surface-strategy Samuel Berthe Помогает решить, какие поверхности интеграции платформа отдаёт наружу — REST, GraphQL, gRPC, вебхуки, SDK, MCP — и в каком порядке их строить. CX Codex +1 8 000установок recoup-platform-api-access recoupable Связывает ассистента с API платформы Recoup и внешними коннекторами. Помогает запрашивать данные артистов, редактировать документы и запускать действия без ручной авторизации. CX Codex +1 4 900установок

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

Весь набор →
Atlassian Requirements to Jira Разбирает файлы требований и формирует из них эпики со связанными историями в Jira. Помогает перенести ТЗ в бэклог без ручного копирования. ★ 40 451звёзд репо arm-migration-agent Субагент переносит кодовую базу с x86 на архитектуру Arm. Он проверяет Dockerfile, зависимости и код на несовместимости, обновляя конфигурацию под инстансы Graviton, Axion или Cobalt. ★ 40 451звёзд репо Senior Cloud Architect Проектирует архитектуру систем, описывает нефункциональные требования и строит Mermaid-диаграммы без генерации рабочего кода. ★ 40 451звёзд репо Arch Linux Expert Субагент для GitHub Copilot, который разбирается в pacman, обновлениях rolling-release и системном администрировании Arch Linux. Пригодится, когда нужно починить систему или настроить службы. ★ 40 451звёзд репо Amplitude Experiment Implementation Субагент для GitHub Copilot, который ведёт фичу от требований в issue до эксперимента в Amplitude и оборачивает код в его варианты. ★ 40 451звёзд репо ai-team-qa Субагент Ivy проводит исследовательское тестирование, проверяет сценарии регрессии и оформляет отчёты об ошибках. Помогает оценить готовность изменений перед релизом. ★ 40 451звёзд репо ai-team-producer Субагент Remy для координации разработки, планирования задач и слияния pull request без написания прикладного кода. ★ 40 451звёзд репо ai-team-dev Субагент, который ведёт задачу от чтения кода до пул-реквеста, совмещая три роли: клиентскую, серверную и работу над опытом пользователя. ★ 40 451звёзд репо

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

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