API And Interface Design

Conception d'API REST/GraphQL et d'interfaces TypeScript pilotée par checklist, avec règles d'erreurs et de nommage.

par addyosmani · addyosmani/agent-skills

Testé · Fonctionne ★ 9.6/10

API And Interface Design — Conception d'API REST/GraphQL et d'interfaces TypeScript pilotée par checklist, avec règles d'erreurs et de nommage.

Ce que fait

Guide la conception d'endpoints REST/GraphQL stables, de limites de modules et de contrats de types TypeScript en s'appuyant sur la loi de Hyrum, une sémantique d'erreur cohérente, la validation aux frontières et des changements strictement additifs. Se déclenche quand un utilisateur conçoit de nouveaux endpoints, définit des contrats entre frontend/backend ou modules, ou modifie une interface publique existante.

Rapport de test

A transformé une API basée sur des verbes (POST /createBookmark, retours incohérents) en routes de ressources correctes, une forme d'erreur unique et cohérente, une pagination par curseur et un type d'ID typé.

Testé le: 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

Commandes et exemples de prompts

/api-and-interface-designConception d'API REST/GraphQL et d'interfaces TypeScript pilotée par checklist, avec règles d'erreurs et de nommage.

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

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

Rapport complet →