What problem does it solve?
Reduce inconsistent, confusing, and fragile REST APIs by providing clear conventions for resource naming, HTTP semantics, response formats, and operational controls so teams deliver predictable, developer-friendly endpoints.
Core Features & Use Cases
- Resource naming & URL structure: guidance on plural nouns, kebab-case, and when to use nested resources or action endpoints.
- HTTP method semantics & status codes: rules for idempotency, correct success and error codes, and structured error payloads.
- Pagination, filtering, auth, rate limiting & versioning: strategies for offset vs cursor pagination, filter/sort conventions, token-based auth patterns, rate-limit headers, and version deprecation timelines.
- Use Case: Standardize a public users and orders API with cursor pagination, consistent error envelopes, auth requirements, and a deprecation plan for breaking changes.
Quick Start
Use the api-design skill to review and standardize a new users API so endpoints use plural kebab-case, correct HTTP methods and status codes, a consistent response envelope, cursor pagination for lists, and appropriate rate-limit and versioning headers.