api-design SKILL.md skillA

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

Install it, pinned

mdr add travisjneuman/.claude/api-design@git:20260207.49cc324

Pins git:20260207.49cc324 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: travisjneuman/.claude
Path: skills/api-design/SKILL.md
Versions recorded: 3
Latest version: git:20260207.49cc324, committed Feb 7, 2026
First version recorded: Dec 18, 2025
Size: 9,992 bytes
Repository stars: 105
License: MIT

REST and GraphQL API design best practices including OpenAPI specs. Use when designing APIs, documenting endpoints, or reviewing API architecture.

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 Guide

Best practices for designing developer-friendly, maintainable APIs.

## REST API Principles

### Resource Naming

**Use nouns, not verbs**:

```
✓ GET /users
✓ GET /users/123
✓ GET /users/123/orders

✗ GET /getUsers
✗ GET /fetchUserById
✗ POST /createNewOrder
```

**Use plural nouns**:

```
✓ /users
✓ /orders
✓ /products

✗ /user
✗ /order
```

**Hierarchical relationships**:

```
/users/{userId}/orders           # User's orders
/users/{userId}/orders/{orderId} # Specific order
```

---

### HTTP Methods

| Method | Purpose                   | Idempotent | Request Body |
| ------ | ------------------------- | ---------- | ------------ |
| GET    | Retrieve resource(s)      | Yes        | No           |
| POST   | Create resource           | No         | Yes          |
| PUT    | Replace resource entirely | Yes        | Yes          |
| PATCH  | Update resource partially | No         | Yes          |
| DELETE | Remove resource           | Yes        | No           |

---

### Status Codes

**Success (2xx)**:

- `200 OK` - Request succeeded
- `201 Created` - Resource created (return Location header)
- `204 No Content` - Success with no response body
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add travisjneuman/.claude/api-design@sha256:603bf18be7eef813

The line at the top of this page pins the label git:20260207.49cc324, 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_p6i4i6zgb7m36sio.svg)](https://markdownregistry.com/a/art_p6i4i6zgb7m36sio)

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

Versions

The registry has recorded 3 versions of this file, between Dec 18, 2025 and Feb 7, 2026, about one every 26 days.

version	committed	commit	size	audit
git:20260207.49cc324 latest	2026-02-07	49cc324	9,992 B	A	view · diff
git:20260113.90b2d6e	2026-01-13	90b2d6e	5,253 B	A	view · diff
git:20251218.8e57ad2	2025-12-18	8e57ad2	5,078 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 (9992 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

travisjneuman/.claude · 105 stars · license MIT · pushed 2026-10-19 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_p6i4i6zgb7m36sio
GET https://markdownregistry.com/api/v1/resolve?ref=travisjneuman/.claude/api-design
GET https://markdownregistry.com/api/v1/blob/603bf18be7eef813f6447901951ed7a846956328482a0e2d9ca8bc3e511141b6

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 travisjneuman/.claude

CLAUDE.md CLAUDE.md file

travisjneuman/.claude · CLAUDE.md

git:20261018.1880985 · audit A · 105 stars

accessibility-a11y SKILL.md skill

travisjneuman/.claude · skills/accessibility-a11y/SKILL.md · WCAG 2.2 compliance, ARIA patterns, keyboard navigation, screen readers, automated testing

git:20260930.c8d311d · audit A · 105 stars

agent-accessibility-expert SKILL.md skill

travisjneuman/.claude · skills/agent-accessibility-expert/SKILL.md · Specialist subagent: WCAG compliance, screen reader compatibility, and inclusive design patterns. Use when auditing…