对比两个 Swagger (OpenAPI 2.0) 文件,生成 Markdown 格式的 API 变更日志。
一键安装(同时安装 cnb-sdk-generator 和 cnb-apidiff):
curl -fsSL https://cnb.cool/cnb/sdk/cnb-sdk-generator/-/git/raw/main/install.sh | sh
通过 Go 安装:
go install cnb.cool/cnb/sdk/cnb-sdk-generator/apidiff/cmd@latest
从源码构建:
go build -o cnb-apidiff ./apidiff/cmd
cnb-apidiff -old <旧版swagger.json> -new <新版swagger.json> [-o 输出文件]
| 参数 | 必填 | 说明 |
|---|---|---|
-old | 是 | 旧版本 Swagger 文件路径 |
-new | 是 | 新版本 Swagger 文件路径 |
-o | 否 | 输出文件路径,默认输出到 stdout |
# 输出到终端
cnb-apidiff -old old.json -new new.json
# 输出到文件
cnb-apidiff -old old.json -new new.json -o changelog.md
生成的 Markdown 包含以下部分: