Section: Versioning strategies

Media type versioning

http
http
Accept: application/vnd.example.v2+json
Explanation

This keeps URLs stable but can make testing and documentation slightly more complex.

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
Path-based versioning
Explicit major version in the URL.
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