rest-api-architect SKILL.md skillA
rest-api-architect from ralvarez-ai/ralvaskills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add ralvarez-ai/ralvaskills/rest-api-architect@v1.2.0Pins v1.2.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- ralvarez-ai/ralvaskills
- Path
skills/protocols/rest-api-architect/SKILL.md- Versions recorded
- 5
- Latest version
- v1.1.1, committed Nov 6, 2026
- First version recorded
- Jul 18, 2026
- Size
- 10,726 bytes
- Repository stars
- 4
- License
- GPL-3.0
Cross-language REST conventions — resource URLs, method semantics, status codes, URL-prefix versioning, cursor pagination, snake_case JSON, ISO 8601 timestamps, RFC 9457 errors, Idempotency-Key, ETag/If-Match, OpenAPI as source of truth. Framework-agnostic. Use when designing or auditing REST endpoints.
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 Architecture
Cross-language conventions for HTTP/JSON REST APIs. Framework-agnostic. Pair with [fastapi-architect](../../frameworks/fastapi-architect/SKILL.md) or [gin-architect](../../frameworks/gin-architect/SKILL.md) for implementation. See [STACK.md](STACK.md) for the specs this skill is built on.
## 1. URL & resource design
- **Plural nouns for collections:** `/v1/users`, `/v1/orders`. Never verbs in URLs (`/v1/createUser` is wrong — the method is the verb).
- **Resource ID in the path:** `/v1/users/{user_id}`, never as a query parameter.
- **Nest only one level deep** for true containment: `/v1/orders/{order_id}/items`. Beyond one level, use IDs and filter queries instead — deeper hierarchies turn brittle the moment relationships change.
- **`snake_case` in URLs and query params.** Consistent with the JSON casing below.
- **Sub-resources expose hierarchy, not actions.** `/v1/orders/{id}/cancellation` (PUT to create) instead of `POST /v1/orders/{id}/cancel`. The state change is *what is created*, not a verb on the parent.
## 2. HTTP method semantics
| Method | Purpose | Idempotent | Safe |
|---|---|---|---|
| `GET` | Read | Yes | Yes (no side effects) |
…Read the whole file at its exact version.
How to install
mdr add ralvarez-ai/ralvaskills/rest-api-architect@sha256:b05002c86275c410The line at the top of this page pins the label v1.2.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_ok4zk5uhhxgg3f4z)
0 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Jul 18, 2026 and Nov 6, 2026, about one every 28 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.1.1 latest | 2026-11-06 | 6bc3c77 | 10,726 B | A | view · diff |
| v1.2.0 | 2026-11-06 | f1dba2a | 10,726 B | A | view · diff |
| v1.1.1 | 2026-09-30 | dda7391 | 10,780 B | A | view · diff |
| v1.1.0 | 2026-09-29 | f288a24 | 10,780 B | A | view · diff |
| v1.1.0 | 2026-07-18 | 8d5aa79 | 10,780 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 (10726 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
ralvarez-ai/ralvaskills · 4 stars · license GPL-3.0 · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ok4zk5uhhxgg3f4z GET https://markdownregistry.com/api/v1/resolve?ref=ralvarez-ai/ralvaskills/rest-api-architect GET https://markdownregistry.com/api/v1/blob/b05002c86275c41025e1fa3f49a4f07f5d41fd1affee831f829a1240d4c11a58
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 ralvarez-ai/ralvaskills
Every file in ralvarez-ai/ralvaskills