api-versioning-strategy

仓库创建 2025年11月8日最近提交 29 天前SkillHot 收录 22 天前
▸ 精选理由

适合规划破坏性变更与多版本迁移的后端团队参考

这个 Skill 做什么

提供 URL/Header/Query 等 API 版本管理策略与弃用路径指南

帮你为 API 选版本管理方案并设计兼容与弃用路径,比较 URL path、Header、Query 等方法的优缺点,给出迁移和回退策略。适合准备破坏性变更或维护多版本时使用,降低消费者升级成本。特点是把技术实现和沟通时间线结合,兼顾缓存、测试与可维护性。

▸ 展开 SKILL.md 英文原文

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 版本兼容性弃用策略通用
180
Stars
28
Forks
40
仓库内 Skill
+0
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/secondsky/claude-skills/main/plugins/api-versioning-strategy/skills/api-versioning-strategy/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/secondsky/claude-skills/main/plugins/api-versioning-strategy/skills/api-versioning-strategy/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
# 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) => ({
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有