监控swagger 接口变动

  • 简介
    • 采用swagger-diff工具,自动监控swagger API 变动情况,不需要人工维护文档说明API变动情况
  • 应用
    • 可结合Gitlab等工具实现API历史版本维护
    • 可结合Jenkins流水线实现自动化监控,作为开发人员和测试人员的连接工具
      • 当dev环境更新API接口时,触发API监控流水线,调用swagger-diff工具,生成变更报告,通过邮件发送报告给测试人员,测试人员根据报告对变动的接口进行相应测试,提高开发人员和测试人员的协同效率
  • 工具
    • swagger-diff
      • GitHub - Sayi/swagger-diff: Compare two swagger API specifications(1.x or v2.0)
  • 原理
    • 监控swagger 接口变动_第1张图片

  • 效果图
    • 监控swagger 接口变动_第2张图片

    • 通过工具对比两个版本的API接口,生成对比结果
      • 新增的接口
      • 删除的接口
      • 更改参数的接口

你可能感兴趣的:(DevOps,swagger)