rest-endpoint-design SKILL.md skillA
rest-endpoint-design from amey-thakur/ai-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add amey-thakur/ai-skills/rest-endpoint-design@git:20260720.1dc980ePins git:20260720.1dc980e in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- amey-thakur/ai-skills
- Path
skills/backend/rest-endpoint-design/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260720.1dc980e, committed Jul 20, 2026
- Size
- 2,622 bytes
- Repository stars
- 14
- License
- MIT
Model REST endpoints around resources with correct status codes, partial updates, and bulk operations. Use when designing or reviewing HTTP APIs and their URL, method, and response conventions.
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
# REST endpoint design
Endpoints model nouns; methods supply the verbs. When you feel the need
for a verb in the URL, you have usually discovered a missing resource.
## Method
1. **Name collections and items, plural, shallow.** `/orders` and
`/orders/{id}`; nest one level only for true ownership
(`/orders/{id}/items`). Deeper nesting bakes today's data model into
every client's URL builder.
2. **Turn actions into resources.** Not `POST /orders/{id}/cancel` as a
remote procedure, but `POST /orders/{id}/cancellation` creating a
cancellation, or `PATCH` of `status`. Long-running work becomes a job
resource: `POST /exports` returns 202 with a `Location` to poll.
3. **Use the codes clients branch on.** 200 with body, 201 with Location
on create, 204 for empty success, 400 validation, 401 vs 403
(unauthenticated vs unauthorized), 404 for both missing and hidden,
409 conflict, 422 semantic rejection, 429 with Retry-After. Never 200
with `{"error": ...}` inside; middleboxes and SDKs trust the code.
4. **PATCH for partial update, PUT for replace.** PATCH with merge
semantics (JSON Merge Patch: null deletes) covers most needs; document
…Read the whole file at its exact version.
How to install
mdr add amey-thakur/ai-skills/rest-endpoint-design@sha256:b5266a6acea838a5The line at the top of this page pins the label git:20260720.1dc980e, 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_v4opuvl7jp2d5s5r)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Jul 20, 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 (2622 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
amey-thakur/ai-skills · 14 stars · license MIT · pushed 2026-09-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_v4opuvl7jp2d5s5r GET https://markdownregistry.com/api/v1/resolve?ref=amey-thakur/ai-skills/rest-endpoint-design GET https://markdownregistry.com/api/v1/blob/b5266a6acea838a5907896561bd31b056bd56970784d1555ba52e55cde276269
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.