Zum Inhalt springen
Kitbay
Skill

api-and-interface-design

MITAktualisiert am 1. Nov. 2026115.373GitHub-Sterne

A skill from Addy Osmani's agent-skills collection for designing stable APIs and interfaces, such as REST or GraphQL endpoints, module boundaries, type contracts and the boundary between frontend and backend.

Was der Skill vermittelt

A skill from Addy Osmani's agent-skills collection for designing stable APIs and interfaces, such as REST or GraphQL endpoints, module boundaries, type contracts and the boundary between frontend and backend. It reminds the agent that any observable behaviour becomes something callers depend on, asks for the contract before the implementation, one error format everywhere, validation only at the edges, additive changes over breaking ones and predictable naming, and explains how to handle idempotency keys safely. It includes REST and TypeScript patterns, a verification checklist and warning signs such as unpaginated lists or verbs in URLs. It has no scripts.

Funktionen

  • Design REST and GraphQL endpoints and type contracts
  • Keep API changes additive and errors consistent
  • Handle idempotency keys safely
  • Check an API against a design checklist