Home / aicodedecode / awesome-muse-skills · GitHub

api-design SKILL.md skillA

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

Install it, pinned

mdr add aicodedecode/awesome-muse-skills/api-design@git:20260927.806f3e1

Pins git:20260927.806f3e1 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: aicodedecode/awesome-muse-skills
Path: skills-imported/api-design/SKILL.md
Versions recorded: 1
Latest version: git:20260927.806f3e1, committed Sep 27, 2026
Size: 13,227 bytes
Repository stars: 25
License: MIT

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

The exact contents, by fingerprint

mdr add aicodedecode/awesome-muse-skills/api-design@sha256:bfae53167acc91ca

The line at the top of this page pins the label git:20260927.806f3e1, 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](https://markdownregistry.com/badge/art_cbnbriipw2fzyrjx.svg)](https://markdownregistry.com/a/art_cbnbriipw2fzyrjx)

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

Versions

The registry has recorded 1 version of this file, committed on Sep 27, 2026.

version	committed	commit	size	audit
git:20260927.806f3e1 latest	2026-09-27	806f3e1	13,227 B	A	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 (13227 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

aicodedecode/awesome-muse-skills · 25 stars · license MIT · pushed 2026-10-10 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_cbnbriipw2fzyrjx
GET https://markdownregistry.com/api/v1/resolve?ref=aicodedecode/awesome-muse-skills/api-design
GET https://markdownregistry.com/api/v1/blob/bfae53167acc91caff0ff9ab73a80ee3fd92caccdfa445c88302c3bf95255156

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 aicodedecode/awesome-muse-skills

21st-dev SKILL.md skill

aicodedecode/awesome-muse-skills · skills-imported/21st-dev/SKILL.md

git:20260930.0d0ec3e · audit C · 25 stars

3d-web-experience SKILL.md skill

aicodedecode/awesome-muse-skills · skills-imported/3d-web-experience/SKILL.md · Expert in building 3D experiences for the web - Three.js, React Three Fiber, Spline, WebGL, and interactive 3D scenes…