What is API Versioning? — UK Software Development Guide
Direct Answer
API versioning is the practice of managing changes to an API by maintaining multiple versions simultaneously, allowing existing API consumers to continue using an older version while new consumers adopt the latest version. Common versioning strategies: URL path versioning (/v1/, /v2/), HTTP header versioning (Accept: application/vnd.api+json;version=2), and query parameter versioning (?version=2).
Api-versioning in the UK
API versioning has specific UK government API implications. The GDS API design guide recommends URL path versioning (/v1/, /v2/) for clarity. HMRC Making Tax Digital API uses URL versioning — v1, v2, v3 versions coexist for backward compatibility. UK regulated sector APIs must maintain backward compatibility to avoid breaking dependent systems — breaking changes to FinTech or HealthTech APIs without adequate deprecation notice can create FCA or NHS compliance incidents. ClickMasters implements URL path versioning on all production APIs, with a minimum 12-month deprecation period for removed endpoints.
Related Glossary Terms
API
API explained for UK software developers and business owners. An API (Application Programming Interface) is a defined set of rules and protocols that allows different software system... UK context, examples, and related services.
Microservices
Microservices explained for UK software developers and business owners. Microservices architecture is a software design approach where an application is built as a collection of small, indepen... UK context, examples, and related services.
Open Banking
Open Banking explained for UK software developers and business owners. Open Banking is the UK's implementation of PSD2 (Payment Services Directive 2) — a regulatory framework that requires th... UK context, examples, and related services.
GRAPHQL
GraphQL explained for UK software developers. GraphQL is a query language for APIs and a server-side runtime for executing those queries, developed by Meta (Facebook)... UK context and related services.
OAUTH
OAuth 2.0 explained for UK software developers. OAuth 2.0 is an authorisation framework that allows applications to obtain limited access to a user's account on another...
Nodejs
Node.js explained for UK software developers. Node.js is an open-source, cross-platform JavaScript runtime environment that executes JavaScript code outside a web bro...
Get Expert Advice on Api-versioning
Speak with our UK software development experts about Api-versioning. Free consultation, transparent pricing, no obligation.