HonestHook

Free API key (1,000/mo)Sign in

Home · Solutions · By who you are

For developers — the contract is the spec, not the blog post

One envelope for every route, errors that are the ones the code returns, and a spec generated from the catalogue rather than written beside it.

The problem

Integrating a data API usually means discovering the shape by calling it, because the documented shape and the returned shape drifted apart. Here the published spec is generated from the same catalogue the router reads, so drift is a build failure, not a surprise in production.

What answers it — 2 endpoints

Shape, parameters and the errors each one returns are in the endpoint reference, generated from the same catalogue the router reads.

Surfaces outside the data catalogue

The recipe

There is no recipe for this one yet. The 3 that exist are all about the archive, and pointing you at one of them from here would send you to steps that do not answer this question. The recipe index says which they are.

Where to go next