api-design SKILL.md skillA
api-design from akaszubski/autonomous-dev is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add akaszubski/autonomous-dev/api-design@git:20260317.e64d556Pins git:20260317.e64d556 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- akaszubski/autonomous-dev
- Path
plugins/autonomous-dev/skills/api-design/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260317.e64d556, committed Mar 17, 2026
- First version recorded
- Feb 13, 2026
- Size
- 8,798 bytes
- Repository stars
- 34
- License
- none declared
REST API design best practices covering versioning, error handling, pagination, and OpenAPI documentation. Use when designing or implementing REST APIs or HTTP endpoints. TRIGGER when: API design, REST endpoint, HTTP route, OpenAPI, swagger, pagination. DO NOT TRIGGER when: internal library code, CLI tools, non-HTTP interfaces.
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 REST API design best practices, HTTP conventions, versioning, error handling, and documentation standards. ## When This Skill Activates - Designing REST APIs - Creating HTTP endpoints - Writing API documentation - Handling API errors - Implementing pagination - API versioning strategies - Keywords: "api", "rest", "endpoint", "http", "json", "openapi" --- ## Core Concepts ### 1. REST Principles RESTful resource design using nouns (not verbs), proper HTTP methods, and hierarchical URL structure. **Key Principles**: - Resources are nouns: `/users`, `/posts` (not `/getUsers`, `/createPost`) - Use HTTP methods correctly: GET (read), POST (create), PUT (replace), PATCH (update), DELETE (remove) - Hierarchical relationships: `/users/123/posts` for related resources - Keep URLs shallow (max 3 levels) **See**: `docs/rest-principles.md` for detailed examples and patterns --- ### 2. HTTP Status Codes Proper status code usage for success (2xx), client errors (4xx), and server errors (5xx). **Common Codes**: - **200 OK**: Successful GET/PUT/PATCH - **201 Created**: Successful POST (includes Location header) - **204 No Content**: Successful DELETE …
Read the whole file at its exact version.
How to install
mdr add akaszubski/autonomous-dev/api-design@sha256:37e4fa6309aeff90The line at the top of this page pins the label git:20260317.e64d556, 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_d3ub44ywjrefx2o3)
6 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Feb 13, 2026 and Mar 17, 2026, about one every 8 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260317.e64d556 latest | 2026-03-17 | e64d556 | 8,798 B | A | view · diff |
| v1.0.0 | 2026-03-06 | 3a09c50 | 8,946 B | A | view · diff |
| v1.0.0 | 2026-02-19 | 4f3e7c2 | 8,808 B | A | view · diff |
| v1.0.0 | 2026-02-19 | 387f926 | 8,220 B | A | view · diff |
| v1.0.0 | 2026-02-13 | c7ec021 | 8,244 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 (8798 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
akaszubski/autonomous-dev · 34 stars · license none declared · pushed 2026-10-04 · branch master
API
GET https://markdownregistry.com/api/v1/artifacts/art_d3ub44ywjrefx2o3 GET https://markdownregistry.com/api/v1/resolve?ref=akaszubski/autonomous-dev/api-design GET https://markdownregistry.com/api/v1/blob/37e4fa6309aeff90e6fa60c59d7aaa3ea165fa6d7843b9b71b5d2c5ab008893e
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 akaszubski/autonomous-dev
Every file in akaszubski/autonomous-dev