Section: Versioning strategies

Path-based versioning

http
http
GET /v1/users
Explanation

Path versioning is simple and highly visible, making it popular for public APIs.

Learn the surrounding workflow

Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.

Related commands

Same sheet · prioritizing Versioning strategies
Media type versioning
Negotiate version with the Accept header.
OpenIn sheethttpsame section
Date-based compatibility header
Pin behavior by release date.
OpenIn sheethttpsame section
Signal deprecations clearly
Warn clients before removing behavior.
OpenIn sheethttpsame section
Bearer token header
Send an OAuth or JWT access token.
OpenIn sheethttp1 tag match
API key header
Send a static API key in a header.
OpenIn sheethttp1 tag match
Do not put tokens in the URL
Keep credentials out of path and query strings.
OpenIn sheettext1 tag match