API And Interface Design

Návrh REST/GraphQL a TypeScript rozhraní podle checklistu, s pravidly pro chyby a pojmenování

od addyosmani · addyosmani/agent-skills

Otestováno · Funguje ★ 9.6/10

API And Interface Design — Návrh REST/GraphQL a TypeScript rozhraní podle checklistu, s pravidly pro chyby a pojmenování

Co umí

Vede návrh stabilních REST/GraphQL endpointů, hranic modulů a TypeScript typových kontraktů pomocí Hyrumova zákona, konzistentní sémantiky chyb, validace hranic a změn pouze přídavného typu. Spouští se, když uživatel navrhuje nové endpointy, definuje kontrakty mezi frontendem/backendem nebo moduly, nebo mění existující veřejné rozhraní.

Testovací report

Proměnil API design založený na slovesech (POST /createBookmark, nekonzistentní návratové hodnoty) na správné resource routy, jednotný tvar chyby, cursor paginaci a značkovaný typ ID.

Testováno: 2026-07-10 · Claude Code 2.x (agent harness)

Instalace

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

Příkazy a ukázkové prompty

  • /api-and-interface-designNávrh REST/GraphQL a TypeScript rozhraní podle checklistu, s pravidly pro chyby a pojmenování

Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):

  • 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