API And Interface Design

Tjekliste-drevet REST/GraphQL- og TypeScript-grænsefladedesign med regler for fejl og navngivning

Af addyosmani · addyosmani/agent-skills

Testet · Virker ★ 9.6/10

API And Interface Design — Tjekliste-drevet REST/GraphQL- og TypeScript-grænsefladedesign med regler for fejl og navngivning

Hvad det gør

Guider design af stabile REST/GraphQL-endpoints, modulgrænser og TypeScript-typekontrakter ud fra Hyrums lov, konsistent fejlsemantik, grænsevalidering og kun-additive ændringer. Trigges når en bruger designer nye endpoints, definerer kontrakter mellem frontend/backend eller moduler, eller ændrer en eksisterende offentlig grænseflade.

Testrapport

Lavede et verbum-baseret API-design (POST /createBookmark, inkonsistente svar) om til rigtige ressource-ruter, ét konsistent fejlformat, cursor-paginering og en branded ID-type.

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

Installation

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-designTjekliste-drevet REST/GraphQL- og TypeScript-grænsefladedesign med regler for fejl og navngivning

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen 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