awesome-api-design SKILL.md skillA

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

Install it, pinned
mdr add khasky/awesome-agent-skills/awesome-api-design@git:20261018.a4259a5

Pins git:20261018.a4259a5 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
khasky/awesome-agent-skills
Path
skills/awesome-api-design/SKILL.md
Versions recorded
8
Latest version
git:20261018.a4259a5, committed Oct 18, 2026
First version recorded
Aug 2, 2026
Size
8,823 bytes
Repository stars
30
License
MIT

Designs or reviews an HTTP API's shape before code: resources, versioning, pagination, idempotency, filtering. Use when asked to design an API or an endpoint.

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

Shape an HTTP API so its consumers can build against it for years without a breaking surprise. The contract is the product: URLs, methods, payloads, errors, and evolution rules are decided here, deliberately — everything left implicit becomes an accidental contract the first client depends on.

## When to Activate

- "Design the API for X", "review this API design / OpenAPI spec", "how should we version / paginate / handle retries".
- A design doc needs its API section made concrete (awesome-design-doc hands off here).
- A new endpoint is being added to an existing API and must match its conventions.

Do not activate to define the error envelope's fields or retry classification (awesome-error-standards owns that contract) or to audit implemented handlers for vulnerabilities (awesome-security-audit).

## Work Process
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add khasky/awesome-agent-skills/awesome-api-design@sha256:9452d325af6e6ace

The line at the top of this page pins the label git:20261018.a4259a5, 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_3l76biqi2ifiqpdx.svg)](https://markdownregistry.com/a/art_3l76biqi2ifiqpdx)

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

Versions

The registry has recorded 8 versions of this file, between Aug 2, 2026 and Oct 18, 2026, about one every 11 days.

versioncommittedcommitsizeaudit
git:20261018.a4259a5 latest2026-10-18 a4259a5 8,823 BA view · diff
git:20261010.3b37a6b2026-10-10 3b37a6b 8,830 BA view · diff
git:20260925.eca990b2026-09-25 eca990b 6,921 BA view · diff
git:20260925.d8504402026-09-25 d850440 7,066 BA view · diff
git:20260910.ad72ad42026-09-10 ad72ad4 7,323 BA view · diff
git:20260905.cad20272026-09-05 cad2027 7,363 BA view · diff
git:20260802.a2205462026-08-02 a220546 7,119 BA view · diff
git:20260802.7f75e7d2026-08-02 7f75e7d 6,267 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 (8823 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

khasky/awesome-agent-skills · 30 stars · license MIT · pushed 2026-10-20 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_3l76biqi2ifiqpdx
GET https://markdownregistry.com/api/v1/resolve?ref=khasky/awesome-agent-skills/awesome-api-design
GET https://markdownregistry.com/api/v1/blob/9452d325af6e6ace03c3e8d03d5521c76cff0d6c7e76739603da95dda1e6048f

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 khasky/awesome-agent-skills

AGENTS.md AGENTS.md file
khasky/awesome-agent-skills · AGENTS.md
git:20261018.a4259a5 · audit A · 30 stars
CLAUDE.md CLAUDE.md file
khasky/awesome-agent-skills · CLAUDE.md
git:20260912.c0b82df · audit B · 30 stars
llms.txt llms.txt file
khasky/awesome-agent-skills · llms.txt
git:20261010.3b37a6b · audit A · 30 stars
awesome-accessibility-audit SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-accessibility-audit/SKILL.md · Read-only WCAG audit of UI and markup with a concrete fix per finding. Use when asked to check accessibility, a11y…
git:20261020.58ea4e8 · audit A · 30 stars
awesome-agents-md-generator SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-agents-md-generator/SKILL.md · Mines a codebase's real commands, conventions and boundaries into an agent-agnostic AGENTS.md, nested per package in…
git:20261018.a4259a5 · audit A · 30 stars
awesome-architecture-audit SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-architecture-audit/SKILL.md · Read-only audit of a whole codebase's design: module boundaries, dependency direction, docs-vs-code drift…
git:20261019.a19c2a5 · audit B · 30 stars
awesome-bug-fix SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-bug-fix/SKILL.md · Fixes a bug through a runnable reproduction and its root cause. Use for errors, crashes, failing tests or builds, flaky…
git:20261020.58ea4e8 · audit A · 30 stars
awesome-claims-audit SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-claims-audit/SKILL.md · Checks public claims (site, README, store listing, privacy policy, structured data) against the code and config that…
git:20261019.a19c2a5 · audit A · 30 stars
awesome-code-cleanup SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-code-cleanup/SKILL.md · Behavior-preserving cleanup of AI-like code noise: narrating comments, dead code, vague names, over-abstraction. Use…
git:20261020.58ea4e8 · audit A · 30 stars
awesome-code-docs SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-code-docs/SKILL.md · Generates a full, cited technical documentation set for a codebase, local or from any git URL: architecture, module and…
git:20261018.a4259a5 · audit A · 30 stars
awesome-code-explainer SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-code-explainer/SKILL.md · Explains how a codebase works, local or from any git URL, as one illustrated page: purpose, stack, structure, entry…
git:20261018.a4259a5 · audit A · 30 stars
awesome-code-review-feedback SKILL.md skill
khasky/awesome-agent-skills · skills/awesome-code-review-feedback/SKILL.md · Handles review comments others left on the user's change: which points to apply, clarify or push back on, each checked…
git:20261020.58ea4e8 · audit A · 30 stars

Every file in khasky/awesome-agent-skills

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