| name | rest-api |
| description | Use this skill when designing REST APIs. Provides REST API design patterns including URL structure, multi-tenancy, request/response formats, HTTP methods, authorization, and testing requirements. |
| version | 1.0.0 |
REST API Design Guidelines
Comprehensive REST API design patterns with focus on multi-tenancy, versioning, and clear API contracts.
When to Use This Skill
Use this skill when:
- Designing new REST API endpoints
- Structuring URLs with multi-tenancy support
- Defining request/response formats and error handling
- Implementing control-plane vs data-plane separation
- Planning API versioning and deprecation strategies
- Setting up authorization patterns and testing requirements
Reference Routing Table
| Reference | Read when you need to… |
|---|
url-design.md | Design URL structure and endpoints — multi-tenancy patterns, control vs data plane separation, naming conventions, versioning |
request-response.md | Define API contracts — HTTP method usage, status codes, request/response structure, error formats, state-changing operations |
advanced-patterns.md | Implement auth/security, performance optimization — migration and deprecation strategies, testing requirements, anti-patterns |
