api-versioning-strategy
Write an API versioning strategy document for a service or API platform. Use when asked to define versioning policy, plan API deprecation, classify breaking changes, or document version lifecycle. Produces a complete versioning strategy with breaking-change classification table, deprecation timeline, migration guide template, and client communication template.
npx skills add mohitagw15856/pm-claude-skills --skill api-versioning-strategy --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# API Versioning Strategy Produce a complete API versioning strategy document that gives a service team durable, consistent rules for evolving their API without breaking consumers. This document covers the versioning scheme selection (with rationale), lifecycle policy from introduction through sunset, a precise breaking-change classification, and all the communication artifacts a team needs when deprecating a version. Engineers should be able to hand this document to a new team member or external consumer and have them understand exactly what to expect. ## Required Inputs Ask for these if not already provided: - **API type** — REST, GraphQL, or gRPC (each has different versioning mechanics) - **Current versioning approach** — URL path (`/v1/`), request header, query parameter, or none; if none, document starts fresh - **Number of existing versions and active consumer count** — needed to size the lifecycle policy and migration scope - **Deprecation timeline constraints** — any hard deadlines (contract SLAs, compliance windows, annual release cycles) - **Consumer type** — internal teams only, external partners, public API, or mix (affects communication channel choices) If any input i
- Required Inputs
- Output Format
- 1. Versioning Scheme
- Selected Approach: [URL Path / Request Header / Query Parameter]
- Version Format
- 2. Version Lifecycle Policy
- Lifecycle Stages
- 3. Breaking vs. Non-Breaking Change Classification
- 4. Deprecation Process
- Step-by-Step Deprecation Checklist
- Deprecation Response Headers
- Sunset Response Body
- 5. Client Communication Templates
- Initial Deprecation Notice
What does the api-versioning-strategy skill do?
Write an API versioning strategy document for a service or API platform. Use when asked to define versioning policy, plan API deprecation, classify breaking changes, or document version lifecycle. Produces a complete versioning strategy with breaking-change classification table, deprecation timeline, migration guide template, and client communication template.
How do I install it?
Run `npx skills add mohitagw15856/pm-claude-skills --skill api-versioning-strategy --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From mohitagw15856/pm-claude-skills, a repository with 1,255 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.