api-design
Installation
SKILL.md
API Design
RESTful Resource Naming
Conventions
| Rule | Good | Bad |
|---|---|---|
| Use plural nouns | /users |
/user, /getUsers |
| Use nouns, not verbs | POST /orders |
POST /createOrder |
| Nest for relationships | /users/123/orders |
/getUserOrders?userId=123 |
| Use kebab-case | /user-profiles |
/userProfiles, /user_profiles |
| Keep URLs shallow (max 3) | /users/123/orders |
/users/123/orders/456/items/789 |
| Use query params for filters | /orders?status=pending |
/orders/pending |
| Collection + resource IDs | /users/123 |
/user?id=123 |