mcpField
A
api-changelog-versioning

api-changelog-versioning

github.com/aj-geddes开发373474 次安装34 周前更新
代码仓库

关于 api-changelog-versioning

用于编写 API 版本文档的技能，涵盖变更、弃用、破坏性变更和迁移说明。支持版本比较，并提供语义化版本管理实践建议。

主要功能

  1. 01按版本记录 API 变更
  2. 02明确标注破坏性变更
  3. 03编写含示例的迁移指南
  4. 04记录弃用事项和支持政策
  5. 05采用语义化版本管理

适用场景

  1. 01准备版本发布日志
  2. 02说明 API 破坏性更新
  3. 03指导使用方升级
  4. 04记录弃用时间安排

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill api-changelog-versioning

安装后在 Claude Code 中输入/api-changelog-versioning确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
breaking-changes.md
improvements.md
new-features.md
security.md
step-1-update-base-url.md
scripts/
validate-api.sh
templates/
api-scaffold.yaml

详细介绍

API 变更日志与版本管理

目录

概述

创建全面的 API 变更日志，记录变更、弃用和重大变更，并为 API 使用者提供迁移指南。

适用场景

  • API 版本变更日志
  • 重大变更文档
  • 版本间迁移指南
  • 弃用通知
  • API 升级指南
  • 向后兼容性说明
  • 版本比较

快速入门

  • 版本比较
# API Changelog

## Version 3.0.0 - 2025-01-15

### 🚨 Breaking Changes

#### Authentication Method Changed

**Previous (v2):**

```http
GET /api/users
Authorization: Token abc123
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [🚨 Breaking Changes](references/breaking-changes.md) | 🚨 Breaking Changes |
| [✨ New Features](references/new-features.md) | ✨ New Features |
| [🔧 Improvements](references/improvements.md) | 🔧 Improvements |
| [🔒 Security](references/security.md) | 🔒 Security, 🗑️ Deprecated, 📊 Version Support Policy |
| [Step 1: Update Base URL](references/step-1-update-base-url.md) | Step 1: Update Base URL, Step 2: Migrate Authentication, Step 3: Update Response Parsing, Step 4: Update Error Handling (+2 more) |

## Best Practices

### ✅ DO

- Clearly mark breaking changes
- Provide migration guides with code examples
- Include before/after comparisons
- Document deprecation timelines
- Show impact on existing implementations
- Provide SDKs for major versions
- Use semantic versioning
- Give advance notice (3-6 months)
- Maintain backward compatibility when possible
- Document version support policy

### ❌ DON'T

- Make breaking changes without notice
- Remove endpoints without deprecation period
- Skip migration examples
- Forget to version your API
- Change behavior without documentation
- Rush deprecations

评论

支持 Markdown