リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。.
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 デザイン パターン
一貫性のある開発者フレンドリーな REST API を設計するための規約とベスト プラクティス。
## アクティブ化するとき
- 新しい API エンドポイントを設計しているとき
- 既存の API 契約をレビューしているとき
- ページネーション、フィルタリング、またはソートを追加しているとき
- API のエラー処理を実装しているとき
- API バージョン管理戦略を計画しているとき
- パブリックまたはパートナー向けの API を構築しているとき
## リソース デザイン
### URL 構造
```
# リソースは名詞、複数形、小文字、ケバブケース
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
# 関係のための サブ リソース
GET /api/v1/users/:id/orders
POST /api/v1/users/:id/orders
# CRUD にマップされないアクション (動詞は慎重に使用)
POST /api/v1/orders/:id/cancel
POST /api/v1/auth/login
POST /api/v1/auth/refresh
```
### 命名規則
```
# よい
/api/v1/team-members # 複数単語リソース用ケバブケース
/api/v1/orders?status=active # フィルタリング用クエリ パラメーター
/api/v1/users/123/orders # 所有権用のネストされたリソース
# 悪い
/api/v1/getUsers # URL 内の動詞
/api/v1/user # 単数形（複数形を使用）
/api/v1/team_members # URL 内のスネークケース
/api/v1/users/123/getOrders # ネストされたリソース内の動詞
```
## HTTP メソッドとステータス コード
### メソッド セマンティクス
| メソッド | べき等 | セーフ | 使用対象 |
|--------|--------|--------|---------|
| GET | はい | はい | リソースを取得 |
| POST | いいえ | いいえ | リソースを作成、アクションをトリガー |
…
The line at the top of this page pins the label git:20260517.ec9ace9, 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 (13351 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 · 293,827 stars · license MIT · pushed 2026-10-30 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_s2qtlostkcyzzmce
GET https://markdownregistry.com/api/v1/resolve?ref=affaan-m/ecc/api-design
GET https://markdownregistry.com/api/v1/blob/211f5a392e0c6a6e384f1e9b9bbe71f10dce6bc1e08c46ef3dde1adf8ce80563
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 · 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…
ericrisco/rsc-harness · skills/api-design/SKILL.md · Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL…
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API wire contracts for REST and GraphQL: resource shape, versioning and deprecation, RFC 9457 errors, OpenAPI. Use when…
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…
