Versioning Protocols

URI Path Versioning

URI path versioning embeds the API version in the URL path, typically as the major version number (e.g., /v1/users, /v2/users). The most widely adopted strategy for public REST APIs due to its explicitness, cache-friendliness, and ease of documentation. Minor and patch changes are deployed in place under the same major version path.

Documentation GitHub

Documentation

📖

Documentation

https://www.askantech.com/api-versioning-strategies-rest-header-url-deprecation-guide/

Schemas & Data

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/versioning-protocols/refs/heads/main/json-schema/versioning-protocols-uri-path-versioning-schema.json

API entry from apis.yml

aid: versioning-protocols:uri-path-versioning
name: URI Path Versioning
description: URI path versioning embeds the API version in the URL path, typically as the major version
  number (e.g., /v1/users, /v2/users). The most widely adopted strategy for public REST APIs due to its
  explicitness, cache-friendliness, and ease of documentation. Minor and patch changes are deployed in
  place under the same major version path.
humanURL: https://www.askantech.com/api-versioning-strategies-rest-header-url-deprecation-guide/
tags:
- URI Versioning
- Path Versioning
- REST
- API Design
properties:
- type: Documentation
  url: https://www.askantech.com/api-versioning-strategies-rest-header-url-deprecation-guide/
- type: JSONSchema
  url: https://raw.githubusercontent.com/api-evangelist/versioning-protocols/refs/heads/main/json-schema/versioning-protocols-uri-path-versioning-schema.json