What is API Versioning?

API Versioning is the practice of managing changes to an API specification across multiple released iterations without breaking existing client integrations.

How it works

Common strategies include URL path versioning (/v1/users), custom header versioning (X-API-Version: 1), and Accept header content negotiation.

Common mistakes

  • Changing field types in minor releases
  • Deprecating endpoints without deprecation headers