Documentation
README
API Design
Core Principles
- Contract-First โ Define API spec before implementation
- OpenAPI 3.2 โ Use OpenAPI for REST API documentation
- URL Versioning โ Version in path
/v1/, with Sunset headers - Idempotency โ PUT/DELETE must be idempotent, POST uses Idempotency-Key
- Cursor Pagination โ Avoid offset-based pagination
- RFC 7807 Errors โ Standard Problem Details format
- No backwards compatibility โ Delete, don't deprecate
Quick Reference
When to Use What
This is the opening of the README. Read the full README on GitHub.