API Design Patterns
38 rules for REST endpoint naming, errors, pagination, versioning, and API security.
Test report
- Verdict
- Tested · Works
- Score
- Tested
- Jul 14, 2026
- Environment
- Claude Code 2.x (agent harness)
- Upstream re-checked
- Aug 10, 2026 · 32945d2
Ran a real 'invoices API' redesign through it: the skill turned verb-based URLs (POST /createInvoice) into proper nouns, replaced a bare error string with a structured envelope (code/message/details/request_id), and added cursor-pagination metadata plus HATEOAS links the naive baseline never had.
Scored on four weighted criteria — install, triggering, output vs. baseline, docs. How scoring works
- Installs cleanly 5/5
- Triggers reliably 5/5
- Output vs. baseline 9/10
- Docs & honesty 5/5
What API Design Patterns does
A condensed rulebook (38 rules / 7 categories) for RESTful API design, covering resource naming, error-response shape, pagination, versioning, and auth. Triggers when designing or reviewing endpoints, or writing error-handling/pagination code, and hands off to per-rule files (rules/*.md) and a 7,200-line compiled AGENTS.md for deep dives.
How to install API Design Patterns
git clone https://github.com/AsyrafHussin/agent-skills
cd agent-skills
mkdir -p ~/.claude/skills
cp -r skills/api-design-patterns ~/.claude/skills/api-design-patterns
Skills live in ~/.claude/skills/ (global) or .claude/skills/
(per-project). Restart Claude Code after installing.
Commands — how to trigger API Design Patterns
-
/api-design-patterns38 rules for REST endpoint naming, errors, pagination, versioning, and API security.
It also activates on plain-language prompts like these:
-
Design a REST API for user management with proper error handling -
Review my API endpoints for best practices before we ship -
What HTTP status codes should I use for this validation error?
Frequently asked questions
- Is the API Design Patterns skill free?
- Yes. The skill itself is free from AsyrafHussin/agent-skills. SkillProof publishes the install command and an independent test verdict at no cost.
- Does API Design Patterns work with Claude Code?
- We tested it with Claude Code 2.x (agent harness) on Jul 14, 2026. Verdict: Tested · Works. Ran a real 'invoices API' redesign through it: the skill turned verb-based URLs (POST /createInvoice) into proper nouns, replaced a bare error string with a structured envelope (code/message/details/request_id), and added cursor-pagination metadata plus HATEOAS links the naive baseline never had.
- What is the API Design Patterns SkillProof Score?
- 9.6/10 — installs cleanly 5/5, triggers reliably 5/5, output vs. baseline 9/10, docs & honesty 5/5.
- How do I install API Design Patterns?
- Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.
- Can I use API Design Patterns with Cursor, Copilot, Gemini CLI, Codex or other AI tools?
- The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.