rest-api-design SKILL.md skillA
rest-api-design from eagerworks/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add eagerworks/skills/rest-api-design@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- eagerworks/skills
- Path
skills/rest-api-design/SKILL.md- Versions recorded
- 2
- Latest version
- v1.0.0, committed Aug 28, 2026
- First version recorded
- Aug 21, 2026
- Size
- 8,621 bytes
- Repository stars
- 15
- License
- MIT
Designs and reviews REST APIs: resource naming, HTTP methods and status codes, payload and error formats, pagination, versioning, auth, rate limiting, and OpenAPI specs. Use when adding or renaming an endpoint, asked "is this endpoint RESTful", "what status code should I return", "design the API for X", or to audit an existing API for consistency or security (IDOR, mass assignment).
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 API Design Skill This skill teaches resource modeling, HTTP semantics, payload/error shapes, pagination, versioning, auth, and OpenAPI — framework-agnostic (plain HTTP, JSON, and OpenAPI YAML). It states one opinionated house style with explicit escape hatches, but that style is a *fallback*, not a mandate: **an existing API's conventions always win.** ## Survey the Existing API First — Do This Before Designing Before proposing a single path or field name, check whether an API already exists in the repo. Never design a new endpoint in isolation from the ones that already ship. ```bash # Find the API surface find . -iname "openapi*.yml" -o -iname "openapi*.yaml" -o -iname "swagger*.json" -not -path "*/node_modules/*" grep -rlE "router\.|@(Get|Post|Put|Patch|Delete)Mapping|app\.(get|post|put|patch|delete)\(|resources :" \ --include="*.rb" --include="*.ts" --include="*.js" --include="*.py" --include="*.java" --include="*.go" . ``` Read a handful of existing endpoints (routes/controllers, serializers, and their tests) and fill in what you observe: | Convention | What to check | |---|---| | Path casing & pluralization | `/user-accounts` vs `/userAccounts` vs `/users` | …
Read the whole file at its exact version.
How to install
mdr add eagerworks/skills/rest-api-design@sha256:97d2bb6bf4ae1f05The line at the top of this page pins the label v1.0.0, 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_sneoflbldfmrbr7a)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Aug 21, 2026 and Aug 28, 2026, about one every 8 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-08-28 | bb12a15 | 8,621 B | A | view · diff |
| git:20260821.77d449d | 2026-08-21 | 77d449d | 9,119 B | A | view |
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 (8621 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
eagerworks/skills · 15 stars · license MIT · pushed 2026-09-12 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_sneoflbldfmrbr7a GET https://markdownregistry.com/api/v1/resolve?ref=eagerworks/skills/rest-api-design GET https://markdownregistry.com/api/v1/blob/97d2bb6bf4ae1f05c3289b20ea01ccd5832880bf54fb16d69ddb33630857a176
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 eagerworks/skills
Every file in eagerworks/skills