Skip to content
uencoder

API Versioning

API versioning manages interface changes so new versions do not break old clients; common schemes are URL path, header, and query parameter versioning.

Purpose

Manage API evolution, ensuring backward compatibility and smooth migration.

Mechanism

URL path: /v1/users (explicit and simple). Header: Accept: application/vnd.api+json;version=1 (RESTful). Query: ?version=1. Semantic versioning: major breaks compatibility, minor adds features, patch fixes bugs. Deprecating old versions requires a transition period.

Use cases

  • API management
  • Backward compatibility
  • Version evolution

Related terms

References