api-design
API Design
Apply these conventions when designing, reviewing, or implementing RESTful APIs. Consistency matters more than cleverness — follow the patterns below.
URL Structure
Use nouns for resources, not verbs. Resources are things, not actions.
| Rule | Correct | Incorrect |
|---|---|---|
| Plural nouns | /users, /orders |
/user, /getOrders |
| Nouns, not verbs | POST /users |
POST /createUser |
| Kebab-case for multi-word | /line-items |
/lineItems, /line_items |
| Nest for relationships (max 2 levels) | /users/:id/orders |
/users/:id/orders/:orderId/items/:itemId |
| Flat when parent is obvious | /orders/:orderId/items |
/users/:userId/orders/:orderId/items |
Query Parameters
Use query parameters for filtering, sorting, searching, and pagination. Never encode these in the URL path.
More from kazdenc/builder-skills
design-brief
One-time setup that gathers design context for your project and saves it to your config file. Run once to establish persistent design guidelines.
31prd
Write a product requirements document from context. Covers problem statement, goals, scope, user stories, success criteria, and edge cases. Use when user says "write a PRD", "product requirements", "requirements doc", "spec this feature", "document requirements", or needs to define what to build and why.
17critique
Evaluate design effectiveness from a UX perspective. Use when user says "critique this design", "review the UX", "give design feedback", "is this good design", "design review", "evaluate this layout", or wants expert evaluative feedback on visual hierarchy, information architecture, and emotional resonance.
14security-scan
Check code for OWASP top 10 vulnerabilities including injection, XSS, auth issues, and secrets exposure. Use when user says "security audit", "check for vulnerabilities", "security scan", "is this secure", "OWASP check", "find security issues", or needs to verify code security before shipping.
13polish
Final quality pass before shipping. Fixes alignment, spacing, consistency, and detail issues. Use when user says "polish this", "final pass", "ready to ship", "fix the details", "pixel-perfect", "almost done", or when a feature is functionally complete but needs refinement.
13env-config
Set up environment variables across local, staging, and production with validation and documentation. Use when user says "set up env vars", "environment variables", "configure secrets", ".env setup", "env validation", or needs to manage configuration across environments.
12