api-design SKILL.md skillA

api-design from skateddu/claude-code-python-setup is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

mdr add skateddu/claude-code-python-setup/api-design@git:20261015.4096849

Pins git:20261015.4096849 in mdr.lock. Pin the fingerprint instead.

Audit grade

A, 17 of 17 checks passed

Kind

SKILL.md skill

Repository

skateddu/claude-code-python-setup

Path

.claude/skills/api-design/SKILL.md

Versions recorded

2

Latest version

git:20261015.4096849, committed Oct 15, 2026

First version recorded

Mar 20, 2026

Size

13,224 bytes

Repository stars

28

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

mdr add skateddu/claude-code-python-setup/api-design@sha256:250e464413a13c0e

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

Versions

The registry has recorded 2 versions of this file, between Mar 20, 2026 and Oct 15, 2026, about one every 209 days.

Audit of the latest version

Source

API

GET https://markdownregistry.com/api/v1/artifacts/art_tnnsw5p7hjgmmvgl
GET https://markdownregistry.com/api/v1/resolve?ref=skateddu/claude-code-python-setup/api-design
GET https://markdownregistry.com/api/v1/blob/250e464413a13c0eb93cc73447b423df1f9aa8e4f80e5e68c41f895b2c33e352

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 skateddu/claude-code-python-setup

Every file in skateddu/claude-code-python-setup

Other files named api-design

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