Skip to content

ADR 6: Use custom header API versioning

Status

Accepted

Context

Although it is preferred that we evolve our APIs rather than version, it is ideal to have an API versioning scheme in place.

Decision

We will use customer header versioning with the key of X-API-Version.

Consequences

Pros

  • The uri remains stable across version changes.
  • As the uri is the same, a new version does not imply a different resource.

Cons