rest-api-best-practices SKILL.md skillA
rest-api-best-practices from okhp3/skillz is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add okhp3/skillz/rest-api-best-practices@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
- okhp3/skillz
- Path
community/rest-api-best-practices/SKILL.md- Versions recorded
- 1
- Latest version
- v1.0.0, committed Aug 28, 2026
- Size
- 8,060 bytes
- Repository stars
- 3
- License
- MIT
REST API design guidance. Use when designing or reviewing REST endpoints, choosing HTTP methods and status codes, defining URL structure and naming conventions, formatting error responses, implementing pagination or filtering, versioning an API, securing endpoints with authentication or rate limiting, or reviewing whether an API exposes domain capabilities rather than raw CRUD operations.
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 Best Practices Use this skill when the main question is how to design, review, or improve a REST API — from URL structure to error formats to security. ## Working Style 1. Start from what the consumer needs, not from what the database looks like. 2. Use HTTP as designed — methods, status codes, and headers carry meaning. 3. Express domain capabilities, not data operations. 4. Make errors as informative as successes. 5. Design for change: version early, break compatibility deliberately. ## Design Workflow 1. **Define the resources.** - What are the concepts the consumer needs to interact with? - Name them with nouns, in plural form. - Avoid verbs in URLs — the HTTP method is the verb. 2. **Choose the right HTTP method.** - GET for retrieval (safe, idempotent, cacheable) - POST for creation or non-idempotent operations - PUT for full replacement (idempotent) - PATCH for partial update - DELETE for removal (idempotent) 3. **Design the URL.** - Keep paths flat where possible — at most two levels of nesting. - Use query parameters for filtering, sorting, and pagination. …
Read the whole file at its exact version.
How to install
mdr add okhp3/skillz/rest-api-best-practices@sha256:032eeb9897908f6eThe 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_ufj3ivfqt7vtp2mg)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Aug 28, 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 (8060 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
okhp3/skillz · 3 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ufj3ivfqt7vtp2mg GET https://markdownregistry.com/api/v1/resolve?ref=okhp3/skillz/rest-api-best-practices GET https://markdownregistry.com/api/v1/blob/032eeb9897908f6ebceb118e73bffa04e53f3c78d9d7f71b82b70cadfc0fff20
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.