api-design
Installation
SKILL.md
API Design
APIs are contracts. Design them as carefully as you would a legal agreement -- they're hard to change once published.
Context
API design defines how system components communicate. A well-designed API is intuitive, consistent, and evolvable. A poorly designed API creates coupling, breaks clients, and generates support burden for years.
In a lifecycle-aware system, API design must preserve upstream architecture boundaries and unresolved questions. Do not smuggle rollout plans, migration choreography, or internal data-model assumptions into the contract unless they are true contract requirements.
Inputs
- architecture-doc -- Required. Defines component boundaries, interaction patterns, and explicit coexistence or compatibility constraints.
- requirements-doc -- Required. Defines required behaviors, authorization expectations, and contract-level non-functional requirements.
- domain-model -- Optional amplifying input when resource naming or entity boundaries need stronger domain vocabulary.