API And Interface Design

Sjekklistedrevet REST/GraphQL- og TypeScript-grensesnittdesign med regler for feil og navngiving

av addyosmani · addyosmani/agent-skills

Bestått ★ 9.6/10

API And Interface Design — Sjekklistedrevet REST/GraphQL- og TypeScript-grensesnittdesign med regler for feil og navngiving

Hva den gjør

Veileder deg gjennom design av stabile REST/GraphQL-endepunkter, modulgrenser og TypeScript-typekontrakter ved hjelp av Hyrums lov, konsekvent feilsemantikk, grensevalidering og kun additive endringer. Utløses når en bruker designer nye endepunkter, definerer kontrakter mellom frontend/backend eller moduler, eller endrer et eksisterende offentlig grensesnitt.

Testrapport

Gjorde om et verbbasert API-design (POST /createBookmark, inkonsekvente returverdier) til ordentlige ressursruter, én konsekvent feilform, markørbasert paginering og en merket ID-type.

Testet på: 2026-07-10 · Claude Code 2.x (agent harness)

Installer

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

Kommandoer og eksempelprompter

  • /api-and-interface-designSjekklistedrevet REST/GraphQL- og TypeScript-grensesnittdesign med regler for feil og navngiving

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen aktiverer prompter som disse skillen (på engelsk):

  • 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