API And Interface Design

Checklistedriven design av REST/GraphQL och TypeScript-gränssnitt med regler för fel och namngivning

av addyosmani · addyosmani/agent-skills

Testad · Fungerar ★ 9.6/10

API And Interface Design — Checklistedriven design av REST/GraphQL och TypeScript-gränssnitt med regler för fel och namngivning

Vad den gör

Guidar designen av stabila REST/GraphQL-endpoints, modulgränser och TypeScript-typkontrakt utifrån Hyrums lag, konsekvent felsemantik, gränsvalidering och enbart additiva ändringar. Aktiveras när en användare designar nya endpoints, definierar kontrakt mellan frontend/backend eller moduler, eller ändrar ett befintligt publikt gränssnitt.

Testrapport

Omvandlade en verbbaserad API-design (POST /createBookmark, inkonsekventa svar) till riktiga resursrutter, ett enhetligt felformat, markörbaserad paginering och en märkt ID-typ.

Testad: 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

Kommandon och exempelprompter

  • /api-and-interface-designChecklistedriven design av REST/GraphQL och TypeScript-gränssnitt med regler för fel och namngivning

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

  • 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