api-design
Installation
SKILL.md
REST API Design
A comprehensive skill for designing production-quality REST APIs. Covers resource naming, HTTP semantics, status codes, pagination, versioning, OpenAPI specs, authentication, error handling, and more.
Capabilities
- Resource Naming - RESTful URI conventions and hierarchy design
- HTTP Method Mapping - Correct use of GET, POST, PUT, PATCH, DELETE
- Status Code Selection - Appropriate codes for every scenario
- Request/Response Design - Envelopes, pagination, filtering, sorting
- API Versioning - URL, header, and query parameter strategies
- OpenAPI Specification - Complete 3.1 spec generation with examples
- Authentication Patterns - API keys, OAuth2, JWT Bearer tokens
- Rate Limiting - Headers, strategies, and client guidance
- HATEOAS - Hypermedia-driven API navigation
- Error Handling - RFC 7807 Problem Details format
- Webhook Design - Event-driven API extension patterns
- Bulk Operations - Batch endpoints and partial failure handling
- Idempotency - Safe retries with idempotency keys