rest-api-patterns
Use when designing REST APIs — resource naming, HTTP methods, status codes, pagination, filtering, error responses, or versioning. Also use when reviewing API design decisions or resolving REST design debates.
| Model | Source |
|---|---|
| sonnet | pack: backend |
Full Reference
┏━ 🔧 rest-api-patterns ━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Use when designing REST APIs — resource naming… ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
rest-api-patterns
Section titled “rest-api-patterns”Reference skill for REST API design. Covers resource naming, HTTP methods, status codes, pagination strategies, error formats (RFC 9457), auth patterns, versioning, rate limiting, and OpenAPI documentation.
Quick Reference
Section titled “Quick Reference”| HTTP Method | Idempotent | Safe | Use |
|---|---|---|---|
| GET | yes | yes | Fetch resource(s) |
| POST | no | no | Create resource, trigger action |
| PUT | yes | no | Full replace |
| PATCH | no | no | Partial update |
| DELETE | yes | no | Remove resource |
| Status Range | Meaning | Key Codes |
|---|---|---|
| 2xx | Success | 200 OK, 201 Created, 204 No Content |
| 3xx | Redirect | 301 Moved, 304 Not Modified |
| 4xx | Client error | 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict, 422 Unprocessable, 429 Too Many Requests |
| 5xx | Server error | 500 Internal, 502 Bad Gateway, 503 Unavailable |
Reference Index
Section titled “Reference Index”| I want to… | File |
|---|---|
| Name resources, structure URLs, and handle edge cases | reference/resource-naming.md |
| Choose HTTP methods and status codes correctly | reference/http-methods.md |
| Implement offset, cursor, and keyset pagination | reference/pagination.md |
| Format error responses with RFC 9457 | reference/error-responses.md |
| Choose and implement auth strategies | reference/auth.md |
| Version an API and handle breaking changes | reference/versioning.md |
| Add rate limiting headers and responses | reference/rate-limiting.md |
| Document APIs with OpenAPI 3.1 | reference/openapi.md |
Usage: Read the reference file matching your current task from the index above. Each file is self-contained with code examples and inline gotchas.