API Design Patterns

38 regler för REST endpoint-namngivning, fel, paginering, versionshantering och API-säkerhet.

av AsyrafHussin · AsyrafHussin/agent-skills

Testad · Fungerar ★ 9.6/10

API Design Patterns — 38 regler för REST endpoint-namngivning, fel, paginering, versionshantering och API-säkerhet.

Vad den gör

En kondenserad regelbok (38 regler / 7 kategorier) för RESTful API-design, som täcker resursnamngivning, felresponsens form, paginering, versionshantering och autentisering. Utlöses vid design eller granskning av endpoints, eller skrivande av felhanterings-/pagineringskod, och hänvisar till per-regel-filer (rules/*.md) och en 7 200-raders kompilerad AGENTS.md för djupdykningar.

Testrapport

Körde en verklig 'invoices API'-omdesign genom den: skillen förvandlade verb-baserade URL:er (POST /createInvoice) till egennamn, ersatte en ren felsträng med ett strukturerat kuvert (code/message/details/request_id), och lade till cursor-pagineringsmetadata plus HATEOAS-länkar som den naiva baslinjen aldrig hade.

Testad: 2026-07-14 · Claude Code 2.x (agent harness)

Installation

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

Kommandon och exempelprompter

/api-design-patterns38 regler för REST endpoint-namngivning, fel, paginering, versionshantering och API-säkerhet.

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

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?

Läs hela rapporten →