API Design Patterns

38 regels voor REST endpoint naming, errors, pagination, versioning, en API security.

Door AsyrafHussin · AsyrafHussin/agent-skills

Getest · Werkt ★ 9.6/10

API Design Patterns — 38 regels voor REST endpoint naming, errors, pagination, versioning, en API security.

Wat het doet

Een gecondenseerd regelboek (38 regels / 7 categorieën) voor RESTful API design, dat resource naming, error-response shape, pagination, versioning en auth behandelt. Activeert bij het ontwerpen of reviewen van endpoints, of het schrijven van error-handling/pagination code, en verwijst naar per-rule files (rules/*.md) en een 7.200-regelige gecompileerde AGENTS.md voor diepgaande analyses.

Testrapport

Voerde een echte 'invoices API' redesign erdoorheen: de skill veranderde werkwoord-gebaseerde URL's (POST /createInvoice) in zelfstandige naamwoorden, verving een kale error string door een gestructureerde envelope (code/message/details/request_id), en voegde cursor-pagination metadata plus HATEOAS links toe die de naïeve baseline nooit had.

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

Installatie

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

Commando's en voorbeeldprompts

  • /api-design-patterns38 regels voor REST endpoint naming, errors, pagination, versioning, en API security.

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

  • 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?