api-design SKILL.md skillA
api-design from jnpiyush/agentx is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jnpiyush/agentx/api-design@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
- jnpiyush/agentx
- Path
.github/skills/architecture/api-design/SKILL.md- Versions recorded
- 5
- Latest version
- v1.0.0, committed Sep 15, 2026
- First version recorded
- Feb 11, 2026
- Size
- 7,518 bytes
- Repository stars
- 19
- License
- Apache-2.0
Design robust REST APIs with proper versioning, pagination, error handling, rate limiting, and documentation. Use when creating new API endpoints, designing resource naming conventions, implementing pagination or filtering, adding rate limiting, or documenting APIs with OpenAPI/Swagger.
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 > **Purpose**: Design robust, maintainable, and user-friendly REST APIs. > **Focus**: Resource naming, HTTP methods, status codes, versioning, documentation. > **Note**: Language-agnostic patterns applicable to any tech stack. --- ## When to Use This Skill - Designing new REST API endpoints - Implementing pagination, filtering, or sorting - Adding rate limiting or CORS configuration - Documenting APIs with OpenAPI/Swagger - Designing webhook notification systems ## Prerequisites - HTTP protocol fundamentals - JSON data format understanding ## Decision Tree ``` Designing an API endpoint? +- What operation? | +- Read data -> GET (idempotent, cacheable) | +- Create resource -> POST (returns 201 + Location header) | +- Full update -> PUT (idempotent, replaces entire resource) | +- Partial update -> PATCH (only changed fields) | - Remove -> DELETE (idempotent, returns 204) +- Returns collection? | - Add pagination (cursor or offset) + filtering + sorting +- Versioning needed? | +- URL path versioning -> /api/v1/resources (recommended) | - Header versioning -> Accept: application/vnd.api.v1+json +- Error handling? …
Read the whole file at its exact version.
How to install
mdr add jnpiyush/agentx/api-design@sha256:908627d57eda3946The 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_vbwqec4s7yvnzsf4)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Feb 11, 2026 and Sep 15, 2026, about one every 54 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-09-15 | f17c505 | 7,518 B | A | view · diff |
| v1.0.0 | 2026-03-01 | 969f335 | 7,516 B | A | view · diff |
| v1.0.0 | 2026-02-16 | 30e409a | 7,530 B | A | view · diff |
| v1.0.0 | 2026-02-11 | e9f9a5c | 7,810 B | A | view · diff |
| v1.0.0 | 2026-02-11 | b2d86bf | 7,535 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 (7518 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
jnpiyush/agentx · 19 stars · license Apache-2.0 · pushed 2026-11-04 · branch master
API
GET https://markdownregistry.com/api/v1/artifacts/art_vbwqec4s7yvnzsf4 GET https://markdownregistry.com/api/v1/resolve?ref=jnpiyush/agentx/api-design GET https://markdownregistry.com/api/v1/blob/908627d57eda3946b7311a7c7102858a6533229d5e4b9a6cee6008c7f4b15290
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.