versioning-apis

Featured

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".

AI & Automation 2,266 stars 315 forks Updated today MIT

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 l...

Details

Author
jeremylongshore
Repository
jeremylongshore/claude-code-plugins-plus-skills
Created
7 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

API & Backend Listed

api-versioning-strategy

Implements API versioning using URL paths, headers, or query parameters with backward compatibility and deprecation strategies. Use when managing multiple API versions, planning breaking changes, or designing migration paths.

160 Updated 2 weeks ago
secondsky
API & Backend Solid

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.

915 Updated 3 days ago
mohitagw15856
AI & Automation Featured

migrating-apis

Implement API migrations between versions, platforms, or frameworks with minimal downtime. Use when upgrading APIs between versions. Trigger with phrases like "migrate the API", "upgrade API version", or "migrate to new API".

2,266 Updated today
jeremylongshore
API & Backend Listed

api-changelog-versioning

Creates comprehensive API changelogs documenting breaking changes, deprecations, and migration strategies for API consumers. Use when managing API versions, communicating breaking changes, or creating upgrade guides.

160 Updated 2 weeks ago
secondsky
AI & Automation Solid

versioning-strategy-helper

Configure with versioning strategy helper operations. Auto-activating skill for API Development. Triggers on: versioning strategy helper, versioning strategy helper Part of the API Development skill category. Use when working with versioning strategy helper functionality. Trigger with phrases like "versioning strategy helper", "versioning helper", "versioning".

2,266 Updated today
jeremylongshore