apidesign SKILL.md skillA

apidesign from vanducng/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add vanducng/skills/apidesign@v0.2.0

Pins v0.2.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
vanducng/skills
Path
skills/apidesign/SKILL.md
Versions recorded
5
Latest version
v0.2.0, committed Sep 11, 2026
First version recorded
Jun 14, 2026
Size
7,383 bytes
Repository stars
8
License
MIT

Design stable, hard-to-misuse interfaces - REST/GraphQL endpoints, module boundaries, type contracts, component props, anything where one piece of code talks to another. Use at design time, before implementing the surface. Triggers: 'design this API', 'API contract', 'endpoint design', 'module boundary', 'interface design', 'should this be one endpoint or two', 'how should this API look'.

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

# apidesign

> Design interfaces that make the right thing easy and the wrong thing hard.

A contract is a commitment. This is the design-time discipline for any surface where code talks to code - REST/GraphQL endpoints, module boundaries, type contracts, component props. Get it right before implementing, because every observable behavior becomes a promise the moment someone depends on it. Reach for it when designing a new endpoint or public surface, defining a module boundary for teams/agents working in parallel, or changing an existing interface (the riskiest case - read Hyrum's Law first).

## What this skill is - and isn't

| Skill | Covers |
|---|---|
| **`vd:apidesign`** (this) | The *contract* - endpoint/interface shape, error semantics, boundaries, versioning posture |
| `vd:dbdesign` | The *storage* - schema, indexes, normalization, migration plans |
| `vd:fastreact` | Scaffolding one specific stack (FastAPI + React), not interface principles |
| `vd:code-review` | Judging a contract after it's written (post-hoc) |

Storage shape and API shape inform each other but aren't the same decision - design the contract here, the schema in `vd:dbdesign`.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add vanducng/skills/apidesign@sha256:509b2aaea282d1df

The line at the top of this page pins the label v0.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.

Badge

mdr badge

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

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

Versions

The registry has recorded 5 versions of this file, between Jun 14, 2026 and Sep 11, 2026, about one every 22 days.

versioncommittedcommitsizeaudit
v0.2.0 latest2026-09-11 9e58ef3 7,383 BA view · diff
v0.2.02026-08-23 87cd06b 8,152 BA view · diff
v0.2.02026-08-19 34c22dc 7,948 BA view · diff
v0.1.02026-07-24 51405ee 7,548 BA view · diff
v0.1.02026-06-14 560f72b 7,598 BA view

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 (7383 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

vanducng/skills · 8 stars · license MIT · pushed 2026-11-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_km5h3ep7oe7mays2
GET https://markdownregistry.com/api/v1/resolve?ref=vanducng/skills/apidesign
GET https://markdownregistry.com/api/v1/blob/509b2aaea282d1dfbd9e627beb3eef8e4731695377b516f6da3bf44f499eb3cf

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 vanducng/skills

AGENTS.md AGENTS.md file
vanducng/skills · AGENTS.md
git:20260724.51405ee · audit A · 8 stars
CLAUDE.md CLAUDE.md file
vanducng/skills · CLAUDE.md
git:20260603.3672559 · audit B · 8 stars
agent-browser SKILL.md skill
vanducng/skills · skills/agent-browser/SKILL.md · Drive web pages with the agent-browser CLI (Playwright engine) - the primary local browser driver. Connect over CDP to…
v0.2.0 · audit A · 8 stars
agent-readiness SKILL.md skill
vanducng/skills · skills/agent-readiness/SKILL.md · Scores how ready a repository is for AI coding agents to work in it effectively, then remediates the gaps - grades…
v1.1.0 · audit A · 8 stars
alter SKILL.md skill
vanducng/skills · skills/alter/SKILL.md · Inspect and safely change Alter, the native macOS AI assistant from alterhq.com, without going through its GUI. Audit…
v1.0.0 · audit A · 8 stars
asciinema SKILL.md skill
vanducng/skills · skills/asciinema/SKILL.md · Record a scripted terminal demo of a CLI or TUI with asciinema: hidden fixture setup, commands typed on screen, TUI…
v1.0.0 · audit A · 8 stars
aside-browser SKILL.md skill
vanducng/skills · skills/aside-browser/SKILL.md · Read when you need a browser, or have to work across user's logged-in websites (e.g. Gmail, Slack, cloud consoles…
v3 · audit B · 8 stars
astro-airflow SKILL.md skill
vanducng/skills · skills/astro-airflow/SKILL.md · Inspect and debug Airflow on Astronomer (Astro) deployments - DAG runs, task logs, container logs, env vars, and…
v1.2.0 · audit A · 8 stars
auto-loop SKILL.md skill
vanducng/skills · skills/auto-loop/SKILL.md · Drive a Claude Code session toward a verifiable goal until done or a hard cap fires - autonomous loop, no user…
v1.0.0 · audit A · 8 stars
aws SKILL.md skill
vanducng/skills · skills/aws/SKILL.md · Operate AWS accounts and services with the AWS CLI using identity-first, read-before-write, evidence-backed workflows…
v0.1.1 · audit A · 8 stars
better-ui SKILL.md skill
vanducng/skills · skills/better-ui/SKILL.md · Applies exact UI polish values: concentric border radius, optical alignment, layered surface shadows, neutral image…
v1.0.1 · audit A · 8 stars
brainstorm SKILL.md skill
vanducng/skills · skills/brainstorm/SKILL.md · Explore the solution space when the path isn't obvious - invent options, stress-test them, pick one. Use for…
v1.4.0 · audit A · 8 stars

Every file in vanducng/skills

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