API Changelog & Versioning 是一项用于编写 API 变更日志和版本管理文档的技能,目标是为 API 使用方提供全面、可读的版本变更记录、废弃说明、破坏性变更说明与迁移指南。
用途 适用于以下场景:API 版本变更日志、破坏性变更文档、版本间迁移指南、废弃通知、API 升级指南、向后兼容说明以及版本对比。
主要能力 技能可产出结构化的 API 变更日志,按版本和时间组织,包含破坏性变更(Breaking Changes)、新功能(New Features)、改进(Improvements)、安全(Security)、废弃(Deprecated)以及版本支持策略(Version Support Policy)等分类。同时支持版本对比以及从旧版本到新版本的迁移步骤,例如更新基础 URL、迁移认证方式、更新响应解析、更新错误处理等。快速开始示例展示了一个 API Changelog 的版本条目格式:版本 3.0.0 日期 2025-01-15,并标注认证方式变更,给出 v2 中 GET /api/users 使用 Authorization: Token abc123 的写法。
使用方式 按版本记录变更条目,并对破坏性变更、新功能、改进、安全、废弃等内容分节说明。参考指南按主题拆分,包括 breaking-changes.md、new-features.md、improvements.md、security.md 以及分步骤的迁移指南(step-1-update-base-url.md 等),涵盖更新基础 URL、迁移认证、更新响应解析、更新错误处理等步骤。迁移指南应附带代码示例与前后对比。
最佳实践 应当:明确标注破坏性变更;提供带代码示例的迁移指南;包含前后对比;记录废弃时间线;说明对现有实现的影响;为主要版本提供 SDK;使用语义化版本;提前通知(3 至 6 个月);尽可能保持向后兼容;记录版本支持策略。 不应:未经通知就做破坏性变更;没有废弃期就移除端点;跳过迁移示例;忘记对 API 进行版本管理;未记录就改变行为;仓促废弃。
限制 该技能不涉及具体 API 的实现细节或运行时行为,仅聚焦于变更文档与版本管理流程的编写规范。未提供的具体价格、平台限制或额外功能信息暂未提供。