Skip to content

.tip

· one of the small things

Put the API version in the path

A version in a header is invisible in logs, in browser dev tools, in curl by default, and in every link anyone pastes into a ticket. /v2/orders is visible in all of them.

GET /v1/orders   → old shape, kept alive with a sunset date
GET /v2/orders   → new shape

Send Deprecation and Sunset headers on the old one, with a date, so clients get a warning a machine can read.

httpapi-design