What problem does it solve?
Inconsistent or non-production-ready REST APIs cause bugs, unclear error handling, poor performance at scale, and missing documentation; this skill provides concrete conventions and patterns to standardize API design for Spring Boot services.
Core Features & Use Cases
- HTTP methods & status codes: guidance on correct method selection, idempotency, and standard success and error codes.
- URL conventions & versioning: resource-based paths, kebab-case, and per-resource versioning rules to avoid breaking clients.
- Error format (RFC 7807): ProblemDetail-based error responses and a global RestControllerAdvice strategy.
- Pagination patterns: offset, cursor, and keyset approaches with implementation notes and trade-offs.
- Validation, rate limiting, and idempotency: bean validation recommendations, rate-limit headers, and idempotency key patterns for safe retries.
- OpenAPI documentation: examples for OpenAPI configuration, annotations, and Swagger UI setup.
- Operations: file upload/download, bulk operations, async jobs with polling and SSE for long-running tasks.
Quick Start
Ask the skill to design REST endpoints for an Orders service including RFC 7807 error responses, cursor pagination, idempotency, and OpenAPI annotations.