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 fridrichmethod/awesome-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add fridrichmethod/awesome-skills/api-design@git:20260517.81511a7

Pins git:20260517.81511a7 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
fridrichmethod/awesome-skills
Path
skills/api-design/SKILL.md
Versions recorded
1
Latest version
git:20260517.81511a7, committed May 17, 2026
Size
13,110 bytes
Repository stars
15
License
a license file GitHub does not identify

REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.

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

The exact contents, by fingerprint
mdr add fridrichmethod/awesome-skills/api-design@sha256:d2b090c4319e030f

The line at the top of this page pins the label git:20260517.81511a7, 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_hlgvsziqlkye52cg.svg)](https://markdownregistry.com/a/art_hlgvsziqlkye52cg)

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

Versions

The registry has recorded 1 version of this file, committed on May 17, 2026.

versioncommittedcommitsizeaudit
git:20260517.81511a7 latest2026-05-17 81511a7 13,110 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 (13110 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

fridrichmethod/awesome-skills · 15 stars · license a license file GitHub does not identify · pushed 2026-10-18 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_hlgvsziqlkye52cg
GET https://markdownregistry.com/api/v1/resolve?ref=fridrichmethod/awesome-skills/api-design
GET https://markdownregistry.com/api/v1/blob/d2b090c4319e030fddb576950400724ff12ccb285083a540b6afb62431185d25

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 fridrichmethod/awesome-skills

13c-metabolic-flux SKILL.md skill
fridrichmethod/awesome-skills · skills/13c-metabolic-flux/SKILL.md · Estimates intracellular metabolic fluxes from steady-state carbon-13 isotope-tracing measurements using validated atom…
v1.2 · audit A · 15 stars
aav-vector-design-agent SKILL.md skill
fridrichmethod/awesome-skills · skills/aav-vector-design-agent/SKILL.md · AI-powered adeno-associated virus (AAV) vector design for gene therapy including capsid engineering, promoter…
git:20260520.7a7a671 · audit A · 15 stars
bio-metagenomics-abundance SKILL.md skill
fridrichmethod/awesome-skills · skills/abundance-estimation/SKILL.md · Turns shotgun classifier output into a defensible abundance table with Bracken Bayesian re-estimation, then…
git:20260614.5d4591c · audit A · 15 stars
academic-humanizer SKILL.md skill
fridrichmethod/awesome-skills · skills/academic-humanizer/SKILL.md · "Improve the clarity and voice of AI-assisted academic writing (papers, theses, rebuttals) and
v0.3.3 · audit A · 15 stars
academic-paper-reviewer SKILL.md skill
fridrichmethod/awesome-skills · skills/academic-paper-reviewer/SKILL.md · Multi-perspective academic paper review with dynamic reviewer personas. Runs a 5-seat, role-separated review panel…
v1.11.1 · audit A · 15 stars
academic-paper SKILL.md skill
fridrichmethod/awesome-skills · skills/academic-paper/SKILL.md · 12-agent academic paper writing pipeline. 11 modes (full/plan/outline/revision/revision-coach/abstract/lit-review/format…
v3.3.1 · audit A · 15 stars
academic-pipeline SKILL.md skill
fridrichmethod/awesome-skills · skills/academic-pipeline/SKILL.md · Orchestrator for the full academic research pipeline: research -> write -> integrity check -> review -> revise ->…
v3.23.0 · audit A · 15 stars
academic-writing SKILL.md skill
fridrichmethod/awesome-skills · skills/academic-writing/SKILL.md · Scholarly writing and research compliance. Use for CRediT, preregistration, Plan S, Nelson Memo, preprints, ORCID, LLM…
git:20260823.528ff10 · audit A · 15 stars
academy-guide SKILL.md skill
fridrichmethod/awesome-skills · skills/academy-guide/SKILL.md · Stop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it…
git:20260823.528ff10 · audit A · 15 stars
access SKILL.md skill
fridrichmethod/awesome-skills · skills/access/SKILL.md · Manage Discord channel access — approve pairings, edit allowlists, set DM/group policy. Use when the user asks to pair…
git:20261004.abbbdf3 · audit A · 15 stars
accessibility-compliance SKILL.md skill
fridrichmethod/awesome-skills · skills/accessibility-compliance/SKILL.md · Implement WCAG 2.2 compliant interfaces with mobile accessibility, inclusive design patterns, and assistive technology…
git:20260524.1fee1b9 · audit A · 15 stars
bio-clinical-databases-acmg-classification SKILL.md skill
fridrichmethod/awesome-skills · skills/acmg-classification/SKILL.md · Applies ACMG/AMP 2015 framework with ClinGen SVI specifications, Tavtigian 2018/2020 Bayesian point system, Abou Tayoun…
git:20260726.5bc48c3 · audit A · 15 stars

Every file in fridrichmethod/awesome-skills

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 · 284,510 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 · 284,510 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 · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 284,510 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,076 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,352 stars
api-design SKILL.md skill
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars
api-design SKILL.md skill
yonatangross/orchestkit · src/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars

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