API And Interface Design

Checklist-gedreven ontwerp van REST/GraphQL- en TypeScript-interfaces, met regels voor errors en naamgeving.

Door addyosmani · addyosmani/agent-skills

Getest · Werkt ★ 9.6/10

API And Interface Design — Checklist-gedreven ontwerp van REST/GraphQL- en TypeScript-interfaces, met regels voor errors en naamgeving.

Wat het doet

Begeleidt het ontwerpen van stabiele REST/GraphQL-endpoints, modulegrenzen en TypeScript-typecontracten, met de wet van Hyrum, consistente foutsemantiek, grensvalidatie en alleen-additieve wijzigingen. Gaat aan wanneer iemand nieuwe endpoints ontwerpt, contracten tussen frontend/backend of modules definieert, of een bestaande publieke interface aanpast.

Testrapport

Maakte van een werkwoord-gebaseerd API-ontwerp (POST /createBookmark, inconsistente returns) nette resource-routes, één consistente errorvorm, cursor-paginering en een branded ID-type.

Getest op: 2026-07-10 · Claude Code 2.x (agent harness)

Installatie

git clone https://github.com/addyosmani/agent-skills
cd agent-skills
mkdir -p ~/.claude/skills
cp -r skills/api-and-interface-design ~/.claude/skills/api-and-interface-design

Commando's en voorbeeldprompts

  • /api-and-interface-designChecklist-gedreven ontwerp van REST/GraphQL- en TypeScript-interfaces, met regels voor errors en naamgeving.

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

  • Design a REST endpoint for order refunds with consistent error semantics
  • Define the TypeScript contract between the frontend and this new service
  • Review this public API change for additive-only compatibility