Capture the core responsibilities, dependencies, and quality attributes that define the service contract. Use the canvas to align product and engineering expectations.
Interface design checklist
Consumer empathy
- Document the top three consumer journeys that rely on the service.
- Provide clear versioning rules and deprecation timelines.
- Offer reference clients or contract tests for high-risk integrations.
Favor API designs that express intent, hide persistence concerns, and shield consumers from internal refactors.
Quality attributes
Define the non-functional requirements that matter most to the service. Prioritize them early to avoid costly rework.
With responsibilities defined, shape the edge contracts in the
API Gateway playbook to keep consumers safe and productive.