common-api-design SKILL.md skillA
common-api-design from hoangnguyen0403/agent-skills-standard is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add hoangnguyen0403/agent-skills-standard/common-api-design@git:20260929.bdf124bPins git:20260929.bdf124b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- hoangnguyen0403/agent-skills-standard
- Path
.claude/skills/common/common-api-design/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260929.bdf124b, committed Sep 29, 2026
- Size
- 3,556 bytes
- Repository stars
- 581
- License
- MIT
Apply REST API conventions — HTTP semantics, status codes, versioning, pagination, and OpenAPI standards for any framework. Use when designing endpoints, choosing HTTP methods, implementing pagination, or writing OpenAPI specs.
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
# 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 - **Lowercase, kebab-case**: `/user-profiles`, not `/UserProfiles` or `/user_profiles`. - **Plural nouns**: `/orders`, `/products`. Not `/order`, `/getProducts`. - **No verbs in paths** (except action sub-resources): `/orders/:id/cancel` ✅, `/cancelOrder` ❌. - **Hierarchy**: Use nesting only up to 2 levels: `/users/:id/orders` ✅, `/users/:id/orders/:orderId/items/:itemId` ❌. ## 🔢 API Versioning - **Strategy**: URL path versioning default: `/v1/users`, `/v2/users`. - **Header versioning** (`Api-Version: 2`) acceptable for internal APIs. …
Read the whole file at its exact version.
How to install
mdr add hoangnguyen0403/agent-skills-standard/common-api-design@sha256:cd1c5613f01a3958The line at the top of this page pins the label git:20260929.bdf124b, 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.
[](https://markdownregistry.com/a/art_2i6om6iglr2u3abe)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 29, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3556 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
hoangnguyen0403/agent-skills-standard · 581 stars · license MIT · pushed 2026-10-22 · branch develop
API
GET https://markdownregistry.com/api/v1/artifacts/art_2i6om6iglr2u3abe GET https://markdownregistry.com/api/v1/resolve?ref=hoangnguyen0403/agent-skills-standard/common-api-design GET https://markdownregistry.com/api/v1/blob/cd1c5613f01a3958ae3bd30d9439d541f66a45449072a7e202a7064757f08b53
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.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from hoangnguyen0403/agent-skills-standard
Every file in hoangnguyen0403/agent-skills-standard