← all insights
#api-design
APIs should be boring on purpose
2026-04-24
An API is a promise to other engineers. The more surprising it is, the more it costs everyone who depends on it. So we aim for boring: predictable shapes, honest errors, and a versioning story that does not bite.
The basics we do not skip
- Clear, documented contracts, ideally generated from the code so they stay honest.
- Stable error shapes, so a client can handle a failure without guessing.
- A deprecation plan before a breaking change, not after.
// A clear, typed response shape
{
"id": "ord_123",
"status": "paid",
"amount": 4200,
"currency": "usd"
}None of this is exciting. That is the point. A boring API is one your consumers stop thinking about, and that is the highest compliment an interface can get.