API Design Patterns

38 regler for REST-endepunktnavngivning, feil, paginering, versjonering og API-sikkerhet.

av AsyrafHussin · AsyrafHussin/agent-skills

Bestått ★ 9.6/10

API Design Patterns — 38 regler for REST-endepunktnavngivning, feil, paginering, versjonering og API-sikkerhet.

Hva den gjør

En kondensert regelbok (38 regler / 7 kategorier) for RESTful API-design, dekker ressursnavngivning, feilresponsform, paginering, versjonering og autentisering. Utløses ved design eller gjennomgang av endepunkter, eller skriving av feilhåndterings-/pagineringskode, og overfører til per-regel-filer (rules/*.md) og en 7 200-linjers kompilert AGENTS.md for dypdykk.

Testrapport

Kjørte en reell 'invoices API'-redesign gjennom den: skill-en gjorde verb-baserte URL-er (POST /createInvoice) om til egennavn, erstattet en ren feilstreng med en strukturert konvolutt (code/message/details/request_id), og la til markør-pagineringsmetadata pluss HATEOAS-lenker den naive baseline aldri hadde.

Testet på: 2026-07-14 · Claude Code 2.x (agent harness)

Installer

git clone https://github.com/AsyrafHussin/agent-skills
cd agent-skills
mkdir -p ~/.claude/skills
cp -r skills/api-design-patterns ~/.claude/skills/api-design-patterns

Kommandoer og eksempelprompter

  • /api-design-patterns38 regler for REST-endepunktnavngivning, feil, paginering, versjonering og API-sikkerhet.

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen aktiverer prompter som disse skillen (på engelsk):

  • Design a REST API for user management with proper error handling
  • Review my API endpoints for best practices before we ship
  • What HTTP status codes should I use for this validation error?