api-versioning-strategy

Featured

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.

API & Backend 221 stars 31 forks Updated today MIT

Install

View on GitHub

Quality Score: 88/100

Stars 20%
78
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
91
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# API Versioning Strategy Choose and implement API versioning approaches with proper deprecation timelines. ## Versioning Methods | Method | Example | Pros | Cons | |--------|---------|------|------| | URL Path | `/api/v1/users` | Clear, cache-friendly | URL clutter | | Header | `API-Version: 1` | Clean URLs | Hidden, harder to test | | Query | `?version=1` | Easy to use | Not RESTful | ## URL Path Versioning (Recommended) ```javascript const v1Router = require('./routes/v1'); const v2Router = require('./routes/v2'); app.use('/api/v1', v1Router); app.use('/api/v2', v2Router); ``` ## Version Adapter Pattern ```javascript // Transform between versions const v1ToV2 = (v1Response) => ({ data: { type: 'user', id: v1Response.user_id, attributes: { name: v1Response.user_name, email: v1Response.email } } }); ``` ## Deprecation Headers ```javascript app.use('/api/v1', (req, res, next) => { res.setHeader('Deprecation', 'true'); res.setHeader('Sunset', 'Sat, 01 Jun 2025 00:00:00 GMT'); res.setHeader('Link', '</api/v2>; rel="successor-version"'); next(); }); ``` ## Safe vs Breaking Changes **Safe Changes** (no version bump): - Adding optional fields - Adding new endpoints - Adding optional parameters **Breaking Changes** (requires new version): - Removing fields - Changing field types - Restructuring responses - Removing endpoints ## Deprecation Timeline | Phase | Duration | Actions | |-------|----------|---------| | Deprecated | 3 m...

Details

Author
secondsky
Repository
secondsky/claude-skills
Created
10 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category