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
1
GitHub Stars
561
First Seen
1 day ago
common-api-design β€” hoangnguyen0403/agent-skills-standard