Changelog Normalizer

Send raw git commit messages or release notes and get back a structured changelog.

原始信息汇总

Changelog Normalizer API 数据集概述

基本信息

• API名称: Changelog Normalizer
• 类别: Text Analysis
• 当前版本: v1.1
• 服务等级: 100%
• 平均延迟: 551ms
• 订阅计划:
  • BASIC: $0.00 / mo
  • PRO: $5.00 / mo

功能概述

该API用于将杂乱的提交日志、发布说明或任何非结构化的变更日志文本，解析并分类为结构化的JSON对象。其将条目排序为五个预定义类别。

核心功能

• 输入: 原始的git提交消息或发布说明。
• 处理: 解析每一行文本并进行分类。
• 输出: 结构化的JSON对象，包含以下五个分类的条目：
  • Breaking Changes: 向后不兼容的更改。
  • Features: 新功能。
  • Fixes: 错误修复和补丁。
  • Deprecations: 已弃用的API或功能。
  • Other: 杂项，如文档、重构、CI等。

工作原理

API采用两阶段分类系统：

1. Conventional Commits: 优先匹配遵循Conventional Commits规范（如 feat:、fix:、BREAKING CHANGE: 等）的消息。
2. 关键词回退: 对于自由格式文本，API会扫描“added”、“fixed”、“deprecated”、“crash”、“new”等关键词。

• 自动去除Markdown项目符号（-、*、#）和其他格式。

端点与请求

• 端点: POST /normalize
• 请求字段:
  • raw (string, 必需): 原始提交消息或发布说明，每行一条。

请求示例

json { "raw": "feat: add user authentication fix: resolve login crash on empty password BREAKING CHANGE: remove legacy /v1 endpoints chore: update dependencies deprecate: old session API docs: update README" }

响应示例

json { "breaking": [ "BREAKING CHANGE: remove legacy /v1 endpoints" ], "features": [ "feat: add user authentication" ], "fixes": [ "fix: resolve login crash on empty password" ], "deprecations": [ "deprecate: old session API" ], "other": [ "chore: update dependencies", "docs: update README" ] }

响应字段

字段	类型	描述
breaking	string[]	重大/向后不兼容的更改
features	string[]	新功能和新增内容
fixes	string[]	错误修复和补丁
deprecations	string[]	弃用通知
other	string[]	杂项，如文档、重构、CI等

支持的输入格式

• Conventional Commits: 例如 feat: add dark mode。
• Markdown项目符号列表: 例如 - Added dark mode support。
• 纯英文文本: 例如 Added dark mode support。

错误处理

状态码	描述
200	成功 — 返回结构化的变更日志
422	验证错误 — raw 字段缺失或无效

应用场景

• CI/CD流水线: 从git日志输出自动生成变更日志。
• 发布工具: 为GitHub Releases、Slack或电子邮件构建发布说明。
• 文档: 将杂乱的提交历史转换为有组织的变更摘要。
• 开发者工具: 为变更日志UI、仪表板或Slack机器人提供支持。

提供方信息

• 创建者: admin
• 订阅者数量: 1