api-design-and-contracts

API guidance for contract design, boundary validation, compatibility, versioning, and consumer-safe changes.

SKILL.md

GitHub

API design and contracts

Core approach

  • Treat APIs as explicit contracts.
  • Keep request, response, and error behavior predictable.
  • Consider compatibility, versioning, and consumer impact before changing surfaces.
  • Validate data at boundaries and avoid ambiguous semantics.

Practical guidance

  • Call out breaking changes and rollout implications clearly.
  • Prefer additive evolution where possible.
  • Keep contract shape, validation, and documentation aligned.