What problem does it solve?
It helps you avoid inconsistent, fragile REST API contracts by standardizing resource naming, HTTP semantics, status codes, error payloads, and pagination/filtering behaviors.
Core Features & Use Cases
- Resource and URL design: Produce predictable, developer-friendly endpoint structures using plural nouns and kebab-case, including nested sub-resources and restrained action endpoints.
- HTTP correctness: Map operations to safe/idempotent methods and choose appropriate success and client/server error codes, including structured validation and conflict responses.
- Scalable list patterns: Implement offset or cursor pagination, plus filtering, sorting, search-like query parameters, sparse fieldsets, and consistent response shapes.
- Production API concerns: Plan versioning strategy, apply authentication/authorization concepts, and define rate limiting headers and tiers.
Quick Start
Use the api-design skill to generate REST API endpoint conventions, request/response schemas, and error handling guidance for a new or reviewed service.