Documentation
README
API Design
Purpose
Design HTTP APIs that clients can use correctly without reading your source code, and that you can evolve without breaking them.
When to Use
- Designing a new API or a new endpoint on an existing one.
- Reviewing an API before it becomes public and therefore permanent.
- Introducing versioning, pagination, or idempotency to an API that lacks them.
- Writing or auditing an OpenAPI specification.
Capabilities
- Resource and URL modeling.
- Status-code semantics and consistent error payloads (RFC 9457 problem details).
- Pagination strategies and their trade-offs.
- Idempotency for unsafe methods.
- Versioning and deprecation without breaking clients.
- OpenAPI specification as the source of truth.
Inputs
This is the opening of the README. Read the full README on GitHub.