api-design SKILL.md skillA
api-design from jamestorrevillas/dev-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jamestorrevillas/dev-skills/api-design@git:20260320.869847aPins git:20260320.869847a in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jamestorrevillas/dev-skills
- Path
.github/skills/api-design/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260320.869847a, committed Mar 20, 2026
- Size
- 3,975 bytes
- Repository stars
- 3
- License
- MIT
Use this skill when designing or reviewing APIs — REST, GraphQL, tRPC, or gRPC. Trigger on keywords: API design, REST, GraphQL, tRPC, gRPC, endpoint, schema, route, OpenAPI, Swagger, API versioning, pagination, API contract, HTTP methods.
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
## Choosing the Right API Type
| Type | Best For | Avoid When |
|---|---|---|
| **REST** | Public APIs, CRUD, simple clients, IoT | Complex nested data, rapid schema iteration |
| **GraphQL** | Mobile apps, complex nested data, multiple clients | Simple CRUD, small teams new to it |
| **tRPC** | TypeScript monorepos, internal full-stack TS APIs | Non-TypeScript clients, public APIs |
| **gRPC** | High-performance microservice comms, streaming | Browser clients, simple use cases |
---
## REST API Design
### URL Conventions
```text
GET /users ← list
GET /users/{id} ← single
POST /users ← create
PUT /users/{id} ← replace
PATCH /users/{id} ← partial update
DELETE /users/{id} ← delete
# Nested resources
GET /users/{id}/orders
POST /users/{id}/orders
# Actions (when REST verbs aren't enough)
POST /orders/{id}/cancel
POST /users/{id}/activate
```
### HTTP Status Codes
| Code | Use When |
|---|---|
| 200 | Successful GET, PUT, PATCH |
| 201 | Successful POST that creates |
| 204 | Successful DELETE (no body) |
| 400 | Validation failure, bad request |
…Read the whole file at its exact version.
How to install
claude plugin marketplace add https://markdownregistry.com/mp/a/art_vejnh44eenr5e36g/abb6b4033f94d5fac7130be851a3262c223b1db7949dc3ae56a7c566580fbd8f.json
Then /plugin install api-design@markdownregistry-vejnh44eenr5e36g in Claude Code. It installs git:20260320.869847a, the one graded A here, pinned to the commit it was graded at, and leaves it there.
mdr add jamestorrevillas/dev-skills/api-design@sha256:abb6b4033f94d5faThe line at the top of this page pins the label git:20260320.869847a, 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_vejnh44eenr5e36g)
2 badge image fetches in 30 days. What the badge shows.
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry
Then ask it: what changed in jamestorrevillas/dev-skills/api-design since the version I have? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.
Got a copy of api-design from somewhere else? Ask it: where did my api-design come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.
Versions
The registry has recorded 1 version of this file, committed on Mar 20, 2026.
Watch this file (sign in, one email per new version)
Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.
It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.
Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.
mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml
It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.
Installed this file, say at .claude/skills/api-design/SKILL.md? Drop it here to learn which saved version you have and what changed since. Your browser works out its SHA-256 fingerprint and sends only that; the file itself never leaves your computer.
Or paste its contents
Your agent can run this same check on the agent markdown files you have installed, up to 50 in one ask. Add the registry once:
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry
Then ask it to check the files you have installed. No key and no account.
From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.
sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies
In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.
sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies
No sha256sum on your machine? shasum -a 256 prints the same lines.
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 (3975 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
jamestorrevillas/dev-skills · 3 stars · license MIT · pushed 2026-03-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_vejnh44eenr5e36g GET https://markdownregistry.com/api/v1/resolve?ref=jamestorrevillas/dev-skills/api-design GET https://markdownregistry.com/api/v1/blob/abb6b4033f94d5fac7130be851a3262c223b1db7949dc3ae56a7c566580fbd8f
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 jamestorrevillas/dev-skills
Every file in jamestorrevillas/dev-skills
Other files named api-design
Browse by kind, by grade A, or by owner.
Kept in .github/skills, the folder GitHub Copilot reads. More agent skills for GitHub Copilot.