Implement API versioning with backward compatibility, deprecation notices, and migration paths.

MITAuto-check passed

Install Versioning APIs

skills CLI
$ npx skills add jeremylongshore/tons-of-skills-marketplace --skill versioning-apis -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install jeremylongshore/tons-of-skills-marketplace versioning-apis --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/jeremylongshore/tons-of-skills-marketplace.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/.curated/versioning-apis .claude/skills/versioning-apis && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
versioning-apis
GitHub stars
2.8k
Token cost
~1.3k tokens
SKILL.md length
564 words
Files
4 (incl. references)
Skills in repo
3,342
Repo updated
First seen
Licence
MIT

At a glance

Implement API versioning with backward compatibility, deprecation notices, and migration paths.

  • Works in 8 steps: Audit existing endpoints using Grep and… → Select a versioning strategy based on… → Create a version router that directs… → …
  • Managing API versions and backward compatibility
  • SKILL.md covers Overview, Prerequisites, Instructions and Output, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Versioning APIs is an agent skill from jeremylongshore/tons-of-skills-marketplace. Implement API versioning with backward compatibility, deprecation notices, and migration paths. Use when managing API versions and backward compatibility. Trigger with phrases like "version the API", "manage API versions", or "handle API versioning".

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including reference files (for example `references/errors.md`, `references/examples.md` and `references/implementation.md`). Compatibility notes: Designed for Claude Code

The repository describes itself as: Model-agnostic agent-skills platform with a harness-free canonical layer, verified adapters, and the ccpi package manager. Explore at tonsofskills.com. The licence is MIT.

When your agent uses it

  • Managing API versions and backward compatibility
  • With phrases like version the API
  • Manage API versions
  • Handle API versioning

Example prompts

  • “version the API”
  • “manage API versions”
  • “handle API versioning”
  • “/versioning-apis”

Requirements

  • Compatibility (from SKILL.md): Designed for Claude Code
  • Pre-approved tools (allowed-tools): Read, Write, Edit, Grep, Glob, Bash(api:version-*)

Workflow steps

8 steps, taken from the first numbered list in SKILL.md.

  1. Audit existing endpoints using Grep and Read to identify current versioning approach (if any) and catalog all public-facing endpoints with…
  2. Select a versioning strategy based on API consumer patterns: URL path versioning for public APIs, header versioning for APIs needing clean…
  3. Create a version router that directs requests to the appropriate version handler set based on the extracted version identifier from URL…
  4. Implement version-specific controller directories (/v1/controllers/, /v2/controllers/) with shared business logic extracted into…
  5. Build a compatibility layer that transforms v1 requests into v2 format and v2 responses back to v1 format, enabling older versions to run…
  6. Add deprecation headers to sunset versions: Deprecation: true, Sunset: , and Link: ; rel="sunset" per the Sunset HTTP header RFC.
  7. Create a breaking change detector that compares OpenAPI specs between versions and flags removed fields, changed types, new required…
  8. Write version compatibility tests that send v1-formatted requests and verify correct responses, ensuring the compatibility layer preserves…

What it can do on your machine

Read from SKILL.md and the folder at commit cfae287. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Write
    • Edit
    • Grep
    • Glob
    • Bash(api:version-*)

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • semver.org

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Designed for Claude Code

    From compatibility in the SKILL.md frontmatter.

Context cost

Versioning APIs loads about 1.3k tokens when it runs, and up to ~3.6k if it reads all its reference files. Until then it costs about 67 tokens; SKILL.md has 564 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~67
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~3.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from jeremylongshore/tons-of-skills-marketplace at commit cfae287, republished under its MIT licence (© jeremylongshore). 564 words, ~1,342 tokens.

Download SKILL.mdSave it as .claude/skills/versioning-apis/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
versioning-apis
description
Implement API versioning with backward compatibility, deprecation notices, and migration paths. Use when managing API versions and backward compatibility. Trigger with phrases like "version the API", "manage API versions", or "handle API versioning".
allowed-tools
Read, Write, Edit, Grep, Glob, Bash(api:version-*)
compatibility
Designed for Claude Code
version
1.26.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
license
MIT
tags
api, migration, versioning-apis

Versioning APIs

Overview

Implement API versioning strategies -- URL path (/v1/, /v2/), header-based (Accept: application/vnd.api.v2+json), or query parameter (?version=2) -- with backward compatibility layers, deprecation notices, and automated migration paths. Manage concurrent version support, sunset timelines, and breaking change detection across the API surface.

Prerequisites

  • Existing API codebase with route definitions and controller implementations
  • Version control history for tracking breaking changes across releases
  • OpenAPI specs for each supported API version (or ability to generate them)
  • API gateway or reverse proxy capable of version-based routing (optional: Kong, AWS API Gateway)
  • Consumer notification channel for deprecation announcements (changelog, email, response headers)

Instructions

  1. Audit existing endpoints using Grep and Read to identify current versioning approach (if any) and catalog all public-facing endpoints with their request/response contracts.
  2. Select a versioning strategy based on API consumer patterns: URL path versioning for public APIs, header versioning for APIs needing clean URLs, or content negotiation for advanced use cases.
  3. Create a version router that directs requests to the appropriate version handler set based on the extracted version identifier from URL, header, or query parameter.
  4. Implement version-specific controller directories (/v1/controllers/, /v2/controllers/) with shared business logic extracted into version-independent service layers.
  5. Build a compatibility layer that transforms v1 requests into v2 format and v2 responses back to v1 format, enabling older versions to run on the latest business logic.
  6. Add deprecation headers to sunset versions: Deprecation: true, Sunset: <date>, and Link: <migration-guide-url>; rel="sunset" per the Sunset HTTP header RFC.
  7. Create a breaking change detector that compares OpenAPI specs between versions and flags removed fields, changed types, new required parameters, and altered response structures.
  8. Write version compatibility tests that send v1-formatted requests and verify correct responses, ensuring the compatibility layer preserves backward compatibility.

See ${CLAUDE_SKILL_DIR}/references/implementation.md for the full implementation guide.

Output

  • ${CLAUDE_SKILL_DIR}/src/routes/v1/ - Version 1 route definitions
  • ${CLAUDE_SKILL_DIR}/src/routes/v2/ - Version 2 route definitions
  • ${CLAUDE_SKILL_DIR}/src/middleware/version-router.js - Version extraction and routing middleware
  • ${CLAUDE_SKILL_DIR}/src/compatibility/ - Request/response transformation layers between versions
  • ${CLAUDE_SKILL_DIR}/src/utils/breaking-change-detector.js - OpenAPI diff tool for breaking changes
  • ${CLAUDE_SKILL_DIR}/docs/migration-guide-v1-to-v2.md - Consumer migration documentation
Show full SKILL.md (234 more words)Show less

Error Handling

ErrorCauseSolution
400 Unsupported VersionClient requests a version that does not existReturn available versions list in error body; suggest closest valid version
410 GoneClient requests a sunset version past its end-of-life dateReturn migration guide URL and recommended current version in error body
Compatibility layer failurev1-to-v2 transform encounters a field with no mappingLog unmapped fields; return partial response with warning header; alert API team
Version header ignoredClient sets version header but reverse proxy strips custom headersDocument required proxy configuration; add URL path fallback for header-based versioning
Breaking change undetectedSemantic change (same field name, different meaning) not caught by schema diffAdd contract tests with business-logic assertions beyond schema structure

Refer to ${CLAUDE_SKILL_DIR}/references/errors.md for comprehensive error patterns.

Examples

URL path versioning: Migrate from /api/users to /api/v1/users and /api/v2/users where v2 changes name (string) to firstName/lastName (object), with v1 compatibility layer that joins the fields.

Header-based versioning: Route requests using Accept: application/vnd.myapi.v2+json with a default version fallback for clients omitting the header, and version discovery via OPTIONS responses.

Sunset lifecycle management: Announce v1 deprecation with 6-month sunset timeline, add Sunset headers immediately, log v1 usage metrics to track migration progress, and auto-disable after sunset date.

See ${CLAUDE_SKILL_DIR}/references/examples.md for additional examples.

Resources

  • RFC 8594 The Sunset HTTP Header Field
  • API Versioning strategies comparison (Stripe, GitHub, Twilio approaches)
  • OpenAPI diff tools: oasdiff, openapi-diff
  • Semantic Versioning 2.0.0: https://semver.org/

© jeremylongshore, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (references) in skills/.curated/versioning-apis of jeremylongshore/tons-of-skills-marketplace.

  • SKILL.md
  • references/errors.md
  • references/examples.md
  • references/implementation.md

Open the folder on GitHubat commit cfae287

Compare with similar skills

Versioning APIs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Versioning APIs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Versioning APIs this skilljeremylongshore/tons-of-skills-marketplace2.8k—~1.3kAutomated safety check: PassMIT
Reversible MigrationJuliusBrussee/caveman111k1 repos~196Automated safety check: PassApache-2.0
DB Migratesimstudioai/sim30k—~2kAutomated safety check: PassApache-2.0
Implementsickn33/agentic-awesome-skills47k5 repos~306Automated safety check: PassMIT
Database Migrationsaffaan-m/ECC277k4 repos~3kAutomated safety check: PassMIT
Database Migrationsaffaan-m/ECC277k1 repos~2.4kAutomated safety check: PassMIT

Similar skills

  • Reversible Migration

    JuliusBrussee/caveman

    Implement reversible compatibility-safe transitions. Use for schema, data, API, protocol, configuration, or dependency migrations requiring rollback and…

    111k GitHub starsUsed in 1 repo~196 tokens
    DevelopmentAuto-check passed
  • DB Migrate

    simstudioai/sim

    Author or review a Drizzle DB migration for zero-downtime safety — expand/contract phasing, backward-compatibility with the deployed app version, and writing the -- migration-safe acknowledgment the…

    30k GitHub stars~2k tokensUpdated today
    DatabasesAuto-check passed
  • Implement

    sickn33/agentic-awesome-skills

    Implement a piece of work based on a PRD or set of issues. An agent skill from sickn33/agentic-awesome-skills.

    47k GitHub starsUsed in 5 repos~306 tokens
    Product & Project ManagementAuto-check passed
  • Safe, reversible database migration patterns: forward-only production changes, expand-contract zero-downtime renames, concurrent indexes, batched backfills, and per-tool workflows for PostgreSQL…

    277k GitHub starsUsed in 4 repos~3k tokens
    DatabasesAuto-check passed
  • Şema değişiklikleri, veri migration'ları, rollback'ler ve PostgreSQL, MySQL ve yaygın ORM'ler (Prisma, Drizzle, Django, TypeORM, golang-migrate) arasında sıfır kesinti deployment'ları için…

    277k GitHub starsUsed in 1 repo~2.4k tokens
    DatabasesAuto-check passed
  • Rules and examples for safe, reversible schema changes in production: zero-downtime column and index changes, large data backfills and ORM migration workflows.

    276k GitHub stars~3.3k tokensUpdated yesterday
    DatabasesAuto-check passed

More from jeremylongshore/tons-of-skills-marketplace

All 3,342 skills in this repo
  • Performing Security Code Review

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to conduct a security-focused code review using the security-agent plugin.

    2.8k GitHub starsUsed in 2 repos~1.3k tokens
    Auto-check: notes
  • Adapting Transfer Learning Models

    jeremylongshore/tons-of-skills-marketplace

    Build this skill automates the adaptation of pre-trained machine learning models using transfer learning techniques.

    2.8k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Agent Context Loader

    jeremylongshore/tons-of-skills-marketplace

    Execute proactive auto-loading: automatically detects and loads agents.md files.

    2.8k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Aggregating Performance Metrics

    jeremylongshore/tons-of-skills-marketplace

    Aggregate and centralize performance metrics from applications, systems, databases, caches, and services.

    2.8k GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Analyzing Capacity Planning

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to analyze capacity requirements and plan for future growth.

    2.8k GitHub stars~947 tokensUpdated today
    Auto-check passed
  • Analyzing Database Indexes

    jeremylongshore/tons-of-skills-marketplace

    Process use when you need to work with database indexing. An agent skill from jeremylongshore/tons-of-skills-marketplace.

    2.8k GitHub stars~2k tokensUpdated today
    Auto-check passed

Questions about Versioning APIs

What does Versioning APIs do?

Implement API versioning with backward compatibility, deprecation notices, and migration paths. Versioning APIs is an agent skill from jeremylongshore/tons-of-skills-marketplace. Implement API versioning with backward compatibility, deprecation notices, and migration paths.

When should I use Versioning APIs?

Versioning APIs fits situations like: managing API versions and backward compatibility; with phrases like version the API; manage API versions; handle API versioning.

How do I install Versioning APIs in Claude Code?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill versioning-apis -a claude-code`. Or copy the skill folder (skills/.curated/versioning-apis in jeremylongshore/tons-of-skills-marketplace) into .claude/skills/versioning-apis in your project. Claude Code loads it when a task matches its description.

How do I install Versioning APIs in Codex?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill versioning-apis -a codex`. Or copy the skill folder (skills/.curated/versioning-apis in jeremylongshore/tons-of-skills-marketplace) into .agents/skills/versioning-apis in your project. Codex loads it when a task matches its description.

Can I use Versioning APIs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill versioning-apis -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/versioning-apis, .gemini/skills/versioning-apis, .github/skills/versioning-apis and .opencode/skills/versioning-apis in your project.

What does Versioning APIs need to run?

SKILL.md names no scripts, command-line tools or credentials: Versioning APIs is instructions for the agent only. Its frontmatter pre-approves these tools: Read, Write, Edit, Grep, Glob, Bash(api:version-*). Compatibility (from SKILL.md): Designed for Claude Code.

Does Versioning APIs access the network?

SKILL.md names 1 domain. As links in the text: semver.org. This is read from the text; nothing was executed.

Is Versioning APIs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Versioning APIs use?

Versioning APIs is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Versioning APIs use?

About 1.3k tokens (SKILL.md is roughly 5.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.3k tokens, read only when the agent opens those files.

What are the alternatives to Versioning APIs?

Skills that share tags, products or a category with Versioning APIs: Reversible Migration (JuliusBrussee/caveman, 111k stars), DB Migrate (simstudioai/sim, 30k stars), Implement (sickn33/agentic-awesome-skills, 47k stars) and Database Migrations (affaan-m/ECC, 277k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Versioning APIs?

jeremylongshore (a GitHub user) maintains it in jeremylongshore/tons-of-skills-marketplace, which has 2,827 GitHub stars. The repository holds 3,342 skills in this directory. The repository was last updated on October 10, 2026.

Source: jeremylongshore/tons-of-skills-marketplace on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.