API Architect — GitHub Copilot subagent: what it does, how to install
This subagent gathers requirements for connecting a client service to an external API, then designs the layers and writes working code. Generation starts when you enter generate.
.github/agents/api-architect.agent.mdWhat API Architect does
API Architect first asks for the programming language, endpoint URL, and at least one REST method. Request and response DTOs are optional; if you leave them out, it creates mock DTOs. You can also provide resilience requirements and test cases.
After you enter generate, it builds three layers: service for REST calls, manager for configuration and testing, and resilience for the requested protections. The instructions require implemented code across all three layers and use of Code Interpreter. It will wait for the required details and the trigger before generating code.
What it helps with
- gather requirements for connecting a client service to an external API
- organize API code into service, manager, and resilience layers
- specify REST operations for an endpoint
- include requested resilience measures and test cases
Example prompts for the agent
- Ask me for the required details and REST methods before designing a connection to an external API.
- Here are the language, endpoint URL, and REST methods. Tell me which DTOs and resilience settings you still need.
- Generate the complete implementation from the agreed requirements:
generate.
How to install API Architect
Manually: put the files in place
.github/agents/api-architect.agent.mdManually: put the files in place
.claude/agents/api-architect.mdFor all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention. Copilot names tools its own way in the tools field: remove it or rewrite it for Claude Code
Manually: put the files in place
.codex/agents/api-architect.tomlCodex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/
Manually: put the files in place
.cursor/agents/api-architect.mdCursor also reads .claude/agents/
Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean
Questions about API Architect
How do I install API Architect in GitHub Copilot?
Add the subagent file at .github/agents/api-architect.agent.md.
What does API Architect do?
It collects external API requirements and produces code split across service, manager, and resilience layers. Enter generate to start code generation.
What details does API Architect need before generating code?
It requires a programming language, endpoint URL, and at least one REST method. DTOs, resilience settings, and test cases are optional inputs.
Source text
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