api-designer SKILL.md skillA
api-designer from nguyenthienthanh/aura-frog is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add nguyenthienthanh/aura-frog/api-designer@git:20260515.6be9f59Pins git:20260515.6be9f59 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- nguyenthienthanh/aura-frog
- Path
aura-frog/skills/api-designer/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260515.6be9f59, committed May 15, 2026
- First version recorded
- Apr 17, 2026
- Size
- 3,170 bytes
- Repository stars
- 25
- License
- MIT
Designs RESTful APIs with endpoint naming, versioning strategies (URL path, header-based), pagination (offset and cursor), error response schemas, and OpenAPI conventions. Use when the user asks about REST API design, creating endpoints, URL structure, API versioning, status codes, Swagger, or OpenAPI specs.
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
> **AI-consumed reference.** Optimized for Claude to read during execution.
> Human-readable explanation: see [docs/architecture/HIERARCHICAL_PLANNING.md](../../../docs/architecture/HIERARCHICAL_PLANNING.md)
> or [docs/getting-started/](../../../docs/getting-started/) depending on topic.
# Skill: API Designer
Design consistent, RESTful APIs with versioning, documentation, and error handling.
---
## RESTful Conventions
| Method | Endpoint | Purpose | Response |
|--------|----------|---------|----------|
| GET | /users | List | 200 + array |
| GET | /users/:id | Get one | 200 / 404 |
| POST | /users | Create | 201 + created |
| PUT | /users/:id | Replace | 200 / 404 |
| PATCH | /users/:id | Update | 200 / 404 |
| DELETE | /users/:id | Delete | 204 / 404 |
Nested: `GET /users/:userId/orders`
---
## Naming
- Resources: plural nouns (`/users`, `/orders`)
- Query params: snake_case (`page_size`)
- Request/Response bodies: camelCase
**Versioning:** URL path `/api/v1/...` (recommended).
---
## Response Format
**Success:** `{ "data": {...}, "meta": {...} }`
**List:** Add `meta: { page, pageSize, total, totalPages }`
…Read the whole file at its exact version.
How to install
mdr add nguyenthienthanh/aura-frog/api-designer@sha256:b973b278e78656c9The line at the top of this page pins the label git:20260515.6be9f59, 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_qdqtg7ubkc7hwlhz)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Apr 17, 2026 and May 15, 2026, about one every 7 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260515.6be9f59 latest | 2026-05-15 | 6be9f59 | 3,170 B | A | view · diff |
| git:20260511.cb3c13c | 2026-05-11 | cb3c13c | 2,879 B | A | view · diff |
| git:20260428.3e00277 | 2026-04-28 | 3e00277 | 2,381 B | A | view · diff |
| git:20260428.bdee323 | 2026-04-28 | bdee323 | 2,359 B | A | view · diff |
| git:20260417.801509f | 2026-04-17 | 801509f | 2,412 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 (3170 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
nguyenthienthanh/aura-frog · 25 stars · license MIT · pushed 2026-10-01 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_qdqtg7ubkc7hwlhz GET https://markdownregistry.com/api/v1/resolve?ref=nguyenthienthanh/aura-frog/api-designer GET https://markdownregistry.com/api/v1/blob/b973b278e78656c95ce70261ea95ed225a87c751fffbbcc2200ae66ddab18916
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 nguyenthienthanh/aura-frog
Every file in nguyenthienthanh/aura-frog