What problem does it solve?
API code often ships with inconsistent status codes, missing input validation, unpaginated list endpoints, and no rate limiting, leading to fragile integrations and security gaps. This Skill provides a concrete checklist of API design rules so every endpoint follows the same contract.
Core Features & Use Cases
- RESTful Design Rules: Enforces plural resource naming, correct HTTP method semantics, and accurate status codes (200, 201, 400, 401, 403, 404, 409, 422, 500).
- Request Validation & Response Format: Requires schema validation with zod, joi, or ajv at the controller layer, plus unified success (
{ data, meta? }) and error ({ error: { code, message, details? } }) response shapes.
- Versioning & Protection: Covers URL-based API versioning, rate limiting by IP/user/API key, timeouts on external calls, and explicit CORS origins.
- Use Case: When building a new
/users endpoint, the Skill ensures you add pagination, sorting, filter whitelists, and a delivery checklist before marking the work complete.
Quick Start
Ask the AI to build or review a REST API endpoint following the hello-api standards, for example: create a paginated GET /v1/users endpoint with validated query parameters.