API Design Skill
Installation
SKILL.md
API Design Skill
Design APIs that developers love to use.
Core Principle
A good API is intuitive, consistent, and hard to misuse. Design for the consumer, not the implementation.
REST Fundamentals
Resource Naming
| Good | Bad | Why |
|---|---|---|
/users |
/getUsers |
Nouns, not verbs |
/users/123 |
/user?id=123 |
Path params for identity |
/users/123/orders |
/getUserOrders |
Hierarchical resources |
/search?q=term |
/search/term |
Query params for filters |