What problem does it solve?
This Skill provides a comprehensive guide to designing REST APIs, addressing common issues such as resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting.
Core Features & Use Cases
- Resource Design: Best practices for URL structure, naming conventions, and resource relationships.
- HTTP Methods and Status Codes: Understanding of method semantics, status code reference, and common mistakes.
- Response Format: Standardized success and error response formats, including JSON examples.
- Pagination: Offset-based and cursor-based pagination methods with use cases.
- Filtering, Sorting, and Search: Implementing filtering, sorting, and full-text search capabilities.
- Authentication and Authorization: Token-based auth and authorization patterns.
- Rate Limiting: Configuring rate limiting with headers and tiers.
- Versioning: URL path and header versioning strategies.
- Implementation Patterns: TypeScript (Next.js), Python (Django), and Go examples.
- API Design Checklist: A checklist for ensuring API quality before deployment.
Quick Start
Use the api-design skill to review the URL structure and HTTP methods for your new API endpoint.