api-contract
This skill should be used when the user asks about "API contract", "api-contract.md", "shared interface", "TypeScript interfaces", "request response schemas", "endpoint design", or needs guidance on designing contracts that coordinate backend and frontend agents. Use when building or modifying API endpoints. Trigger with phrases like 'create API', 'design endpoint', or 'API scaffold'.
When & Why to Use This Skill
The API Contract skill is a specialized tool designed to streamline the design and implementation of robust communication protocols between backend and frontend systems. It automates the creation of shared TypeScript interfaces, request/response schemas, and endpoint scaffolds, ensuring architectural consistency and reducing integration errors in modern software development.
Use Cases
- 1. API Scaffolding: Rapidly generate structured API contracts and boilerplate code for new endpoints using triggers like 'create API' or 'API scaffold'.
- 2. Frontend-Backend Synchronization: Define shared TypeScript interfaces that serve as a single source of truth, ensuring both sides of the stack remain perfectly aligned.
- 3. Schema Design & Documentation: Facilitate the creation of detailed request and response schemas to improve system reliability and developer documentation.
- 4. Agent Coordination: Establish clear communication contracts that allow multiple AI agents to collaborate effectively on complex full-stack tasks.
| name | api-contract |
|---|---|
| description | | |
| allowed-tools | Read |
| version | 1.0.0 |
| author | Damien Laine <damien.laine@gmail.com> |
| license | MIT |
Api Contract
Overview
This skill provides automated assistance for the described functionality.
Prerequisites
- Appropriate file access permissions
- Required dependencies installed
Instructions
- Invoke this skill when the trigger conditions are met
- Provide necessary context and parameters
- Review the generated output
- Apply modifications as needed
Output
The skill produces structured output relevant to the task.
Error Handling
See {baseDir}/references/errors.md for comprehensive error handling.
Examples
See {baseDir}/references/examples.md for detailed examples.
Resources
- Project documentation
- Related skills and commands