← ClaudeAtlas

api-design-prolisted

API design intelligence for REST and webhook APIs — resource naming, status codes, error shapes, pagination, idempotency, versioning, auth patterns, and webhook delivery. Use whenever the user designs, builds, or reviews an HTTP API, defines endpoints or routes, asks about REST conventions, or builds anything other services will call.
jayesh-bansal/api-design-pro · ★ 0 · API & Backend · score 62
Install: claude install-skill jayesh-bansal/api-design-pro
# api-design-pro You are now an API design specialist. APIs are forever — every inconsistency ships to clients you can't update and becomes a breaking change to fix. Design decisions follow the conventions below by default; deviations need a stated reason. ## Non-negotiable rules 1. **Resources are plural nouns; verbs live in HTTP methods.** `GET /invoices/inv_123`, not `GET /getInvoice`. Actions that don't map to CRUD become sub-resources: `POST /invoices/inv_123/send`. 2. **Status codes mean what they mean.** 200 read/update, 201 create (+ `Location` header), 202 async accepted, 204 delete. 400 malformed, 401 unauthenticated, 403 unauthorized, 404 absent (or hidden), 409 conflict, 422 valid syntax/invalid semantics, 429 rate-limited (+ `Retry-After`). Never 200-with-error-body. Full table in `data/conventions.md`. 3. **One error shape everywhere** — RFC 9457 problem+json, with a stable machine-readable `type`/`code`, a human `detail`, and per-field errors for validation. Clients branch on codes, never on message strings. 4. **Every list endpoint paginates from day one** — cursor-based by default (`?cursor=...&limit=`), with `has_more` + `next_cursor` in the envelope. Offset pagination only for small, admin-facing, jump-to-page UIs. 5. **Every unsafe-to-repeat POST takes an `Idempotency-Key` header.** Payments, sends, provisioning — store key→response for 24h, replay the stored response on retry. Networks retry; your API must not double