api-design SKILL.md skillA

This file is byte-identical to the first copy the registry indexed. Same content hash, so the same checks give both the same grade.

api-design from ronnasayd/aipp is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add ronnasayd/aipp/api-design@git:20261027.315f0f5

Pins git:20261027.315f0f5 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
ronnasayd/aipp
Path
skills/everything-claude-code/api-design/SKILL.md
Versions recorded
5
Latest version
git:20261027.315f0f5, committed Oct 27, 2026
First version recorded
May 17, 2026
Size
13,224 bytes
Repository stars
3
License
none declared

REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs. Use when designing or reviewing REST endpoints, resource names, status codes, pagination, or versioning.

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 Patterns

Conventions and best practices for designing consistent, developer-friendly REST APIs.

## When to Activate

- Designing new API endpoints
- Reviewing existing API contracts
- Adding pagination, filtering, or sorting
- Implementing error handling for APIs
- Planning API versioning strategy
- Building public or partner-facing APIs

## Resource Design

### URL Structure

```
# Resources are nouns, plural, lowercase, kebab-case
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# Sub-resources for relationships
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# Actions that don't map to CRUD (use verbs sparingly)
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh
```

### Naming Rules

```
# GOOD
/api/v1/team-members          # kebab-case for multi-word resources
/api/v1/orders?status=active  # query params for filtering
/api/v1/users/123/orders      # nested resources for ownership

# BAD
/api/v1/getUsers              # verb in URL
/api/v1/user                  # singular (use plural)
…

Read the whole file at its exact version.

How to install

No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_impwziez2ehallva/250e464413a13c0eb93cc73447b423df1f9aa8e4f80e5e68c41f895b2c33e352.json

Then /plugin install api-design@markdownregistry-impwziez2ehallva in Claude Code. It installs git:20261027.315f0f5, the one graded A here, pinned to the commit it was graded at, and leaves it there.

The exact contents, by fingerprint
mdr add ronnasayd/aipp/api-design@sha256:250e464413a13c0e

The line at the top of this page pins the label git:20261027.315f0f5, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_impwziez2ehallva.svg)](https://markdownregistry.com/a/art_impwziez2ehallva)

1 badge image fetches in 30 days. What the badge shows.

Ask from your agent
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry

Then ask it: what changed in ronnasayd/aipp/api-design since the version I have? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.

Got a copy of api-design from somewhere else? Ask it: where did my api-design come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.

Versions

The registry has recorded 5 versions of this file, between May 17, 2026 and Oct 27, 2026, about one every 41 days.

Watch this file (sign in, one email per new version)

versioncommittedcommitsizeaudit
git:20261027.315f0f5 latest2026-10-27 315f0f5 13,224 BA view · diff
git:20260819.f6bc9e42026-08-19 f6bc9e4 13,227 BA view · diff
git:20260711.2886deb2026-07-11 2886deb 13,122 BA view · diff
git:20260518.2a9e2d62026-05-18 2a9e2d6 13,110 BA view · diff
git:20260517.c0443762026-05-17 c044376 13,622 BA view

Copies

Copies in other repositories

1 file in 1 other repository holds the exact bytes of one of this file's versions, each committed after this file had them: it holds an older version.

A copy does not update when this file does. Whoever holds one can learn which version it is with the Check your copy box below, or by asking their agent. Matched on exact bytes and commit dates only.

Keep it current by itself, install once

Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

Install on GitHub

It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.

Keep it current by itself

Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml

It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.

Check a whole project

From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies

In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies

No sha256sum on your machine? shasum -a 256 prints the same lines.

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (13224 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

GitHub

ronnasayd/aipp · 3 stars · license none declared · pushed 2026-11-18 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_impwziez2ehallva
GET https://markdownregistry.com/api/v1/resolve?ref=ronnasayd/aipp/api-design
GET https://markdownregistry.com/api/v1/blob/250e464413a13c0eb93cc73447b423df1f9aa8e4f80e5e68c41f895b2c33e352

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 ronnasayd/aipp

AGENTS.md AGENTS.md file
ronnasayd/aipp · AGENTS.md
git:20261105.0bfe3dc · audit A · 3 stars
CLAUDE.md CLAUDE.md file
ronnasayd/aipp · CLAUDE.md
git:20260919.ef9a503 · audit A · 3 stars
AGENTS.md@claude/dev-mods/tool-history AGENTS.md file
ronnasayd/aipp · claude/dev-mods/tool-history/AGENTS.md
git:20261105.4ba4217 · audit A · 3 stars
discovery-process SKILL.md skill
ronnasayd/aipp · skills/Product-Manager-Skills/discovery-process/SKILL.md · Run a full discovery cycle from problem hypothesis to validated solution. Use when a team needs a structured path…
git:20261109.95e8e67 · audit A · 3 stars
prd-development SKILL.md skill
ronnasayd/aipp · skills/Product-Manager-Skills/prd-development/SKILL.md · Build a structured PRD that connects problem, users, solution, and success criteria. Use when turning discovery notes…
git:20261109.95e8e67 · audit A · 3 stars
user-story-mapping SKILL.md skill
ronnasayd/aipp · skills/Product-Manager-Skills/user-story-mapping/SKILL.md · Create a user story map that lays out activities, steps, tasks, and release slices. Use when planning a workflow…
git:20261109.95e8e67 · audit A · 3 stars
user-story-splitting SKILL.md skill
ronnasayd/aipp · skills/Product-Manager-Skills/user-story-splitting/SKILL.md · Break a large story or epic into smaller deliverable stories using proven split patterns. Use when backlog items are…
git:20261109.95e8e67 · audit A · 3 stars
user-story SKILL.md skill
ronnasayd/aipp · skills/Product-Manager-Skills/user-story/SKILL.md · Create user stories with Mike Cohn format and Gherkin acceptance criteria. Use when turning user needs into…
git:20261109.95e8e67 · audit A · 3 stars
skill-inspector SKILL.md skill
ronnasayd/aipp · skills/SkillSpector/skill-inspector/SKILL.md · Review AI agent skills before installation using NVIDIA SkillSpector and source-aware semantic review. Use when asked…
git:20261027.315f0f5 · audit A · 3 stars
adversarial-dev SKILL.md skill
ronnasayd/aipp · skills/adversarial-dev/SKILL.md · Orchestrates a code task through two separate agents in an adversarial loop — an executor that implements and a strict…
v1.0.0 · audit A · 3 stars
agent-creator SKILL.md skill
ronnasayd/aipp · skills/agent-creator/SKILL.md · Create new specialist agents, modify and improve existing agents, and validate agent behavior. Use when users want to…
v1.0.0 · audit A · 3 stars
skill-judge SKILL.md skill
ronnasayd/aipp · skills/agent-toolkit/skill-judge/SKILL.md · Evaluate Agent Skill design quality against official specifications and best practices. Use when reviewing, auditing…
git:20260926.0cb2534 · audit A · 3 stars

Every file in ronnasayd/aipp

Other files named api-design

api-design SKILL.md skill
affaan-m/ecc · docs/es/skills/api-design/SKILL.md · Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de…
git:20260607.ac0f11c · audit A · 305,967 stars
api-design SKILL.md skill
affaan-m/ecc · .agents/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260918.c752aac · audit A · 305,967 stars
api-design SKILL.md skill
affaan-m/ecc · .kiro/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260323.535120d · audit A · 305,967 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 305,967 stars
api-design SKILL.md skill
cbrock84/headcount · plugins/technology/skills/api-design/SKILL.md · Designs interfaces that survive their consumers — resource modeling, errors, versioning, pagination, and compatibility…
git:20260916.e72e404 · audit A · 2,543 stars
api-design SKILL.md skill
hashgraph-online/awesome-codex-plugins · plugins/Colin4k1024/tsp/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260512.6523792 · audit A · 1,584 stars
api-design SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/api-design/SKILL.md · RESTful and GraphQL API design: OpenAPI specs, pagination, rate limiting, error schemas, versioning, and backwards…
git:20260923.ffaa29c · audit A · 626 stars
api-design SKILL.md skill
ericrisco/rsc-harness · skills/api-design/SKILL.md · Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL…
git:20261109.ba0e80d · audit A · 608 stars

Browse by kind, by grade A, or by owner.