Contract-First API Design
Ontwerp het API-contract vóór de code: versiebeheer, idempotentie, cursor paging.
Getest · Werkt
Wat het doet
Een doctrine skill die Claude het API-contract laat schrijven vóór enige implementatiecode, waarbij de juiste standaard voor het protocol (OpenAPI, AsyncAPI, proto, GraphQL SDL) wordt gekozen en versiebeheer, foutcodes, idempotentie sleutels, cursor paginering, rate-limit headers en een deprecation policy worden vastgelegd. Activeert wanneer u vraagt om een nieuwe API of endpoint te ontwerpen, of om te controleren of een wijziging bestaande clients breekt. Geen scripts, geen tooling — het is een review- en authoring checklist die het model op uw ontwerp toepast.
Testrapport
Ontwierp twee keer dezelfde URL-shortener API — één keer koud, één keer volgens de skill body — en vergeleek de twee contracten met een 13-punten contractrubriek: de koude versie scoorde 3, de skill-versie 13. De skill-run voegde de dingen toe die later breaking changes zijn om te retrofitten: een vereiste Idempotency-Key op POST (de koude conceptversie sloeg stilzwijgend een tweede korte code aan bij herhaling), gesigneerde cursor paginering met een max limiet in plaats van page/offset, machine-leesbare error_code plus request_id op elke response, X-RateLimit-* headers, een Sunset deprecation policy en een oasdiff CI gate. Het ving ook een tweede contractoppervlak op dat de koude conceptversie volledig miste — de Kafka click event heeft zijn eigen AsyncAPI artefact nodig. Kosten: de skill-gedreven pass dreef af naar contractmechanica en liet twee domeinregels vallen die de koude conceptversie had (code recycling window, collision retry), dus het vult productdenken aan in plaats van het te vervangen.
Getest op: 2026-07-28 · Claude Code 2.x (agent harness)
Installatie
git clone https://github.com/robisson/build-like-amazon-agent-skills.git mkdir -p ~/.claude/skills cd build-like-amazon-agent-skills && cp -r skills/api-contract-first ~/.claude/skills/contract-first-api-design
Commando's en voorbeeldprompts
/contract-first-api-designOntwerp het API-contract vóór de code: versiebeheer, idempotentie, cursor paging.
Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):
Design the REST API contract for our new billing service before codingWe're adding v2 endpoints, how do we avoid breaking existing clients?What pagination and idempotency contract should POST /payments have?