logo
0
0
WeChat Login
ForkfromBring/Notify/CNBOpenAPI, behindmain3 commits

CNB API Swagger 变更监控

images

项目简介

这是一个自动监控 CNB Open API 变更的项目。项目会定期检查 Swagger API 定义,当检测到接口变化时,会自动在 Issue 中发表评论通知,帮助用户及时了解 API 更新情况。

功能特性

  • 🔍 自动检测 API 接口增减
  • 🔧 检测接口参数变化
  • 📢 检测到变更时自动发送通知评论
  • 📝 记录完整的 Swagger JSON 历史
  • ⏰ 定时自动执行,无需人工干预

API 信息

项目通过以下 API 获取数据:

  • Swagger 地址https://api.cnb.cool/swagger.json
  • 版本信息https://cnb.cool/api/version

工作原理

  1. 定时任务触发 check.sh 脚本
  2. 脚本拉取最新 Swagger JSON 和版本信息
  3. 提取所有接口路径、方法、参数
  4. 与本地保存的上次 Swagger JSON 进行对比
  5. 如果检测到变化,构造变更报告并在 Issue 中发表评论
  6. 更新本地 Swagger 记录文件

变更检测

脚本会检测以下变化:

变化类型说明
新增接口新增的 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_TOKENAPI 访问令牌
ISSUE_NUMBER评论目标 Issue 编号(默认 1)

About

No description, topics, or website provided.