api-design SKILL.md skillA
api-design from komluk/scaffolding is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add komluk/scaffolding/api-design@git:20260520.3aa374bPins git:20260520.3aa374b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- komluk/scaffolding
- Path
skills/api-design/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260520.3aa374b, committed May 20, 2026
- First version recorded
- Apr 9, 2026
- Size
- 5,316 bytes
- Repository stars
- 16
- License
- MIT
RESTful API design standards: resource naming, HTTP methods, status codes, pagination, versioning. TRIGGER when: designing new API endpoints, defining error response shapes, or adding pagination/filtering. SKIP: implementing FastAPI route code (use python-patterns); error-handling internals (use error-handling).
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 Skill
## Purpose
Standards and best practices for designing RESTful APIs.
## Auto-Invoke Triggers
- Designing new API endpoints
- Creating OpenAPI documentation
- Implementing API versioning
- Designing error responses
- Implementing pagination
---
## REST API Principles
### Resource Naming
- Use **nouns**, not verbs: `/users` not `/getUsers`
- Use **plural** nouns: `/users` not `/user`
- Use **kebab-case**: `/user-profiles` not `/userProfiles`
- Use **lowercase** only
- Max **2 levels** nesting: `/users/{id}/posts`
### URL Patterns
| Pattern | Example | Use Case |
|---------|---------|----------|
| Collection | `/users` | List resources |
| Item | `/users/{id}` | Single resource |
| Nested | `/users/{id}/posts` | Related resources |
| Action | `/users/{id}/activate` | Non-CRUD operations |
---
## HTTP Methods
| Method | Purpose | Idempotent | Safe | Has Body |
|--------|---------|------------|------|----------|
| GET | Read | Yes | Yes | No |
| POST | Create | No | No | Yes |
| PUT | Replace entire resource | Yes | No | Yes |
| PATCH | Partial update | No | No | Yes |
| DELETE | Remove | Yes | No | No |
### Method Selection Rules
…Read the whole file at its exact version.
How to install
mdr add komluk/scaffolding/api-design@sha256:4c23c8cc6ccde56fThe line at the top of this page pins the label git:20260520.3aa374b, 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_dvlaj55gauogmrrn)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Apr 9, 2026 and May 20, 2026, about one every 41 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260520.3aa374b latest | 2026-05-20 | 3aa374b | 5,316 B | A | view · diff |
| git:20260409.25dc3ca | 2026-04-09 | 25dc3ca | 5,141 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 (5316 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
komluk/scaffolding · 16 stars · license MIT · pushed 2026-11-08 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_dvlaj55gauogmrrn GET https://markdownregistry.com/api/v1/resolve?ref=komluk/scaffolding/api-design GET https://markdownregistry.com/api/v1/blob/4c23c8cc6ccde56fd001438d69a29fdf0de0628d5d01d1b52725b1e2ab2578ce
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 komluk/scaffolding
Every file in komluk/scaffolding