REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs. Use when designing or reviewing REST endpoints, resource names, status codes, pagination, or versioning.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# API Design Patterns
Conventions and best practices for designing consistent, developer-friendly REST APIs.
## When to Activate
- Designing new API endpoints
- Reviewing existing API contracts
- Adding pagination, filtering, or sorting
- Implementing error handling for APIs
- Planning API versioning strategy
- Building public or partner-facing APIs
## Resource Design
### URL Structure
```
# Resources are nouns, plural, lowercase, kebab-case
GET /api/v1/users
GET /api/v1/users/:id
POST /api/v1/users
PUT /api/v1/users/:id
PATCH /api/v1/users/:id
DELETE /api/v1/users/:id
# Sub-resources for relationships
GET /api/v1/users/:id/orders
POST /api/v1/users/:id/orders
# Actions that don't map to CRUD (use verbs sparingly)
POST /api/v1/orders/:id/cancel
POST /api/v1/auth/login
POST /api/v1/auth/refresh
```
### Naming Rules
```
# GOOD
/api/v1/team-members # kebab-case for multi-word resources
/api/v1/orders?status=active # query params for filtering
/api/v1/users/123/orders # nested resources for ownership
# BAD
/api/v1/getUsers # verb in URL
/api/v1/user # singular (use plural)
…
The line at the top of this page pins the label git:20260918.c752aac, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
A 17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
pass: Frontmatter block present
pass: Frontmatter declares a name
pass: Frontmatter declares a description
pass: Size between 200 bytes and 200 KB (13216 bytes)
pass: No zero-width or bidi control characters
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag
Source
GitHub
affaan-m/ecc · 284,510 stars · license MIT · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ekv4rcuehbx2r7vu
GET https://markdownregistry.com/api/v1/resolve?ref=affaan-m/ecc/api-design
GET https://markdownregistry.com/api/v1/blob/5568a8b1e2e9ea1cc1433535ba8fcf9c21309b996108887343150d4fc76992e6
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
affaan-m/ecc · .agents/skills/agent-sort/SKILL.md · Build an evidence-backed ECC install plan for a specific repo by sorting skills, commands, rules, hooks, and extras…
affaan-m/ecc · .agents/skills/article-writing/SKILL.md · Write articles, guides, blog posts, tutorials, newsletter issues, and other long-form content in a distinctive voice…
affaan-m/ecc · .agents/skills/backend-patterns/SKILL.md · Backend architecture patterns, API design, database optimization, and server-side best practices for Node.js, Express…
affaan-m/ecc · .agents/skills/benchmark-methodology/SKILL.md · Use after competitive-platform-analysis has produced a tiered competitor set. Scores each competitor across nine…
affaan-m/ecc · .agents/skills/brand-discovery/SKILL.md · Use when a brand needs to discover or articulate its identity through structured multi-session interviews. Covers…
affaan-m/ecc · .agents/skills/brand-voice/SKILL.md · Build a source-derived writing style profile from real posts, essays, launch notes, docs, or site copy, then reuse that…
affaan-m/ecc · .agents/skills/bun-runtime/SKILL.md · Bun as runtime, package manager, bundler, and test runner. When to choose Bun vs Node, migration notes, and Vercel…
affaan-m/ecc · .agents/skills/competitive-platform-analysis/SKILL.md · Use when scoping a competitive landscape — identifying, categorising, and score-filtering a competitor set before any…
affaan-m/ecc · .agents/skills/competitive-report-structure/SKILL.md · Use after benchmark-methodology has produced scored competitor profile cards. Assembles findings into a decision-grade…
affaan-m/ecc · docs/es/skills/api-design/SKILL.md · Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de…
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
yonatangross/orchestkit · src/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
majiayu000/spellbook · skills/api-design/SKILL.md · REST/GraphQL/gRPC API design best practices. Use when designing APIs, defining contracts, handling versioning. Covers…
