common-api-design

Installation
SKILL.md

Common API Design Standards

Priority: P1 (HIGH)

🔧 HTTP Verb Semantics

  • GET read-only, idempotent — never mutates state.
  • POST create or trigger; PUT full replace; PATCH partial update; DELETE remove.
  • Non-CRUD actions as sub-resources: POST /orders/:id/cancel.

📡 Status Code Correctness

  • 200 success; 201 created (add Location header); 204 no body.
  • 400 validation (with details[]); 401 unauthenticated; 403 unauthorized; 404 not found.
  • 409 conflict; 422 business rule violation; 429 rate limit (add Retry-After); 500 unhandled.

📦 URL Design Rules

Installs
3
GitHub Stars
580
First Seen
Sep 5, 2026