api-design SKILL.md skillA

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

Install it, pinned
mdr add dragonked2/alphacode/api-design@git:20260923.ffaa29c

Pins git:20260923.ffaa29c in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
dragonked2/alphacode
Path
src/alphacode_base/bundled_skills/api-design/SKILL.md
Versions recorded
2
Latest version
git:20260923.ffaa29c, committed Sep 23, 2026
First version recorded
Sep 23, 2026
Size
1,273 bytes
Repository stars
626
License
MIT

RESTful and GraphQL API design: OpenAPI specs, pagination, rate limiting, error schemas, versioning, and backwards compatibility.

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

Design clean, consistent, and maintainable APIs.

## RESTful Design Principles

- Use nouns for resources, HTTP verbs for actions
- Consistent URL patterns: `/resources/{id}/sub-resources`
- Proper HTTP status codes (200, 201, 204, 400, 401, 403, 404, 409, 422, 500)
- Stateless: each request contains all needed info
- HATEOAS: include links for discoverability

## API Response Schema

```json
{
  "data": {},
  "meta": { "page": 1, "per_page": 20, "total": 100 },
  "links": { "self": "...", "next": "...", "prev": "..." },
  "errors": []
}
```

## Error Schema

```json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable description",
    "details": [{"field": "email", "issue": "invalid format"}]
  }
}
```

## Key Patterns

- **Pagination**: cursor-based for large datasets, offset for small
- **Filtering**: query params `?status=active&created_after=2024-01-01`
- **Sorting**: `?sort=-created_at,name`
- **Rate Limiting**: 429 + Retry-After header
- **Versioning**: URL path (`/v2/`) or header
- **Idempotency**: idempotency keys for safe retries

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_zutslgyo7tfq5mak/a5cb0dbe5da92c7548a5afc9b2d42a00462804d3e62347ddb0d920c5ed6f4c48.json

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

The exact contents, by fingerprint
mdr add dragonked2/alphacode/api-design@sha256:a5cb0dbe5da92c75

The line at the top of this page pins the label git:20260923.ffaa29c, 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_zutslgyo7tfq5mak.svg)](https://markdownregistry.com/a/art_zutslgyo7tfq5mak)

6 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 dragonked2/alphacode/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 2 versions of this file, all committed on Sep 23, 2026.

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

versioncommittedcommitsizeaudit
git:20260923.ffaa29c latest2026-09-23 ffaa29c 1,273 BA view · diff
git:20260923.82a41432026-09-23 82a4143 1,271 BA view
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 (1273 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

dragonked2/alphacode · 626 stars · license MIT · pushed 2026-11-16 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_zutslgyo7tfq5mak
GET https://markdownregistry.com/api/v1/resolve?ref=dragonked2/alphacode/api-design
GET https://markdownregistry.com/api/v1/blob/a5cb0dbe5da92c7548a5afc9b2d42a00462804d3e62347ddb0d920c5ed6f4c48

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 dragonked2/alphacode

AGENTS.md AGENTS.md file
dragonked2/alphacode · AGENTS.md
git:20261111.5b671c4 · audit A · 626 stars
api-builder SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/api-builder/SKILL.md · Expert REST API design and implementation — endpoint design, authentication, error handling, rate limiting, versioning…
git:20260923.ffaa29c · audit A · 626 stars
api-security SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/api-security/SKILL.md · API security testing: authentication bypass, authorization flaws, rate limiting, input validation, GraphQL…
git:20260923.ffaa29c · audit A · 626 stars
architecture-review SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/architecture-review/SKILL.md · Review system architecture: module boundaries, dependency direction, coupling analysis, and scalability assessment.
git:20260923.ffaa29c · audit A · 626 stars
backend-dev SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/backend-dev/SKILL.md · Comprehensive backend development methodology covering API design, authentication, database design, caching, testing…
git:20260923.ffaa29c · audit A · 626 stars
backend-dev/auth SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/backend-dev/auth/SKILL.md · Authentication and authorization — JWT access/refresh token rotation, OAuth2 PKCE/client credentials, session…
git:20260923.82a4143 · audit A · 626 stars
backend-dev/caching SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/backend-dev/caching/SKILL.md · Caching strategies — HTTP caching, CDN, application-level caching (Redis, Memcached), cache invalidation patterns…
git:20260923.82a4143 · audit A · 626 stars
backend-dev/database SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/backend-dev/database/SKILL.md · Database patterns — schema design, indexing strategies, query optimization, connection pooling, migration management…
git:20260923.82a4143 · audit A · 626 stars
backend-dev/nodejs SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/backend-dev/nodejs/SKILL.md · Node.js/Express/Fastify backend development — project structure, middleware patterns, route design, validation…
git:20260923.82a4143 · audit A · 626 stars
backend-dev/python SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/backend-dev/python/SKILL.md · Python/FastAPI/Django backend development — async patterns, Pydantic models, dependency injection, middleware…
git:20260923.82a4143 · audit A · 626 stars
backend-dev/rust SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/backend-dev/rust/SKILL.md · Rust/Axum/Actix-web backend development — handler patterns, extractors, middleware, error handling, state management…
git:20260923.82a4143 · audit A · 626 stars
bug-bounty-methodology SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/bug-bounty-methodology/SKILL.md · Real-world security assessment methodology with program-specific workflows, time management, and reporting discipline…
git:20260929.29bbcb8 · audit C · 626 stars

Every file in dragonked2/alphacode

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
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
api-design SKILL.md skill
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API wire contracts for REST and GraphQL: resource shape, versioning and deprecation, RFC 9457 errors, OpenAPI. Use when…
v2.0.0 · audit A · 304 stars

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