这是一个自动监控 CNB Open API 变更的项目。项目会定期检查 Swagger API 定义,当检测到接口变化时,会自动在 Issue 中发表评论通知,帮助用户及时了解 API 更新情况。
项目通过以下 API 获取数据:
https://api.cnb.cool/swagger.jsonhttps://cnb.cool/api/versioncheck.sh 脚本脚本会检测以下变化:
| 变化类型 | 说明 |
|---|---|
| 新增接口 | 新增的 API 端点 |
| 删除接口 | 移除的 API 端点 |
| 参数变化 | 接口参数的新增、删除或修改 |
check.sh - API 变更检测和通知脚本last_swagger.json - 保存上次检测到的完整 Swagger JSON.cnb.yml - CI/CD 配置文件,定义定时任务# 设置环境变量
export CNB_REPO_SLUG="your/repo"
export CNB_TOKEN="your_token"
# 运行检测脚本
./check.sh
| 变量名 | 说明 | 必填 |
|---|---|---|
CNB_REPO_SLUG | 仓库路径,格式:用户名/仓库名 | 是 |
CNB_TOKEN | API 访问令牌 | 是 |
ISSUE_NUMBER | 评论目标 Issue 编号(默认 1) | 否 |