API And Interface Design

Design di interfacce REST/GraphQL e TypeScript guidato da checklist, con regole su errori e naming

di addyosmani · addyosmani/agent-skills

Promosso ★ 9.6/10

API And Interface Design — Design di interfacce REST/GraphQL e TypeScript guidato da checklist, con regole su errori e naming

Cosa fa

Guida la progettazione di endpoint REST/GraphQL stabili, confini tra moduli e contratti di tipo TypeScript applicando la legge di Hyrum, una semantica degli errori coerente, la validazione dei confini e modifiche solo additive. Si attiva quando l'utente progetta nuovi endpoint, definisce contratti tra frontend/backend o moduli, oppure modifica un'interfaccia pubblica esistente.

Rapporto di test

Ha trasformato un design API basato su verbi (POST /createBookmark, ritorni incoerenti) in route a risorse corrette, un formato di errore coerente, paginazione a cursore e un tipo ID branded.

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

Installazione

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

Comandi e prompt di esempio

  • /api-and-interface-designDesign di interfacce REST/GraphQL e TypeScript guidato da checklist, con regole su errori e naming

Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):

  • 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