| name | custom-http-rest-api |
|---|---|
| description | Language-agnostic REST API design spec (.json, .ex, .rb, .py). Covers OpenAPI 3.1 contract, token auth, versioning, pagination (offset + cursor), sorting, filtering (operator grammar), sparse fieldsets, sideloading, HATEOAS, rate limiting, error codes (RFC 9457), concurrency (ETags), idempotency, bulk operations, async jobs, webhooks, CORS, security headers, and JSONB replace semantics. |
A language-agnostic specification for building consistent, production-grade JSON REST APIs. All APIs following this spec share the same authentication model, response format, pagination, error handling, and query conventions.
Note: All payload examples in this document are illustrative. Replace resource names, fields, and values with those specific to your application.