api-design - Generate implementable API design documents
Generates implementable API design documents from requirements and design documents, including contracts, key code design, error codes, and examples.
Tags
Updated: 2026-10-03Capabilities
Typical Inputs
Typical Outputs
What this skill does
- Collect design inputs
- Identify API interfaces
- Define interface contracts
- Design key code skeletons
- Define error codes
- Generate API documents
- Validate API completeness
Inputs
- Design documents
- Requirement documents
- Dependency API documents
- Storage configuration
- User confirmations
Outputs
- API design documents
- Interface contract definitions
- Key code designs
- Error code definitions
- Request and response examples
- Stage confirmation prompts
- Generated API files
Requirements
- Access to project files
- Configured storage path or user-provided location
- User confirmation between workflow stages