📝 版本信息
➕ 添加变更条目
📊 变更列表
⚙️ 输出选项
📄 生成结果
📚 API变更日志生成器能做什么?
API变更日志生成器帮助开发者根据API端点变更自动生成规范的Changelog文档。支持语义化版本建议、多种输出格式、变更分类管理。
核心功能
• 六种变更类型:Added/Changed/Deprecated/Removed/Fixed/Security
• 语义化版本建议:根据变更类型自动推荐版本号
• 多种输出格式:Markdown/JSON/HTML
• 批量导入:JSON格式批量添加变更
• Keep a Changelog规范:符合社区标准
使用教程
1. 填写版本号和日期
2. 逐条添加变更条目(选择类型+描述)
3. 或通过JSON批量导入
4. 选择输出格式并生成
5. 复制或下载Changelog
应用场景
• API版本发布:每次发布自动生成变更记录
• 团队协作:统一变更记录格式
• 文档维护:自动维护CHANGELOG.md
• CI/CD集成:导出JSON集成到自动化流程
扩展知识
Keep a Changelog是社区维护的Changelog规范,建议按Added/Changed/Deprecated/Removed/Fixed/Security分类。语义化版本(SemVer)使用MAJOR.MINOR.PATCH格式:破坏性变更升MAJOR,新增功能升MINOR,修复升PATCH。良好的Changelog是API可维护性的关键。
❓ 常见问题
什么是API变更日志?
API变更日志(Changelog)记录API的每次变更,包括新增端点、修改参数、删除功能等。它帮助API消费者了解变更内容,评估升级影响。
支持哪些变更类型?
支持Added(新增)、Changed(修改)、Deprecated(废弃)、Removed(删除)、Fixed(修复)、Security(安全)六种标准变更类型,符合Keep a Changelog规范。
如何判断版本号变更?
根据语义化版本规则:新增功能→MINOR版本、破坏性变更→MAJOR版本、修复→PATCH版本。工具根据变更类型自动建议版本号。
输出格式是什么?
默认输出Markdown格式的Changelog,符合Keep a Changelog规范。也支持JSON格式输出,方便集成到自动化流程中。
可以自定义模板吗?
可以。支持自定义Changelog模板,包括标题格式、日期格式、分类顺序等。也支持添加自定义变更类型。
支持批量添加变更吗?
支持。可以通过JSON格式批量导入变更条目,也可以逐条添加。每条变更可指定类型、描述和影响范围。