API Versioning

What it does

Provides practical guidance, templates and checklists for API versioning strategy and backward-compatibility management. Includes recommended patterns (URL path, header, query), SemVer guidance, deprecation/sunset processes, and migration patterns with examples and header conventions.

When to use it

When you need to choose or document an API versioning approach, prepare for breaking changes, publish migration guides, or run a deprecation plan for existing endpoints. Useful during API design, major releases, and when coordinating client migrations.

What's included

• Scripts: none listed (has_scripts: false)
• References: design docs and templates referenced in frontmatter (migration-guide-template, deprecation-notice-template, breaking-changes.md)
• Instructions: step-by-step recommendations for choosing versioning style, semantic versioning mapping to URL patterns, deprecation flow with HTTP headers, and examples for migration and data transformation.

Compatible agents

{ }

This skill is a knowledge-rich reference suitable for developer-facing assistant workflows (code-writing and API design helpers).