swagger接口注释添加，接口版本变更规则

为了方便接口测试用例后期维护和对变更点及时测试，接口变更内容要及时通知到测试组，为了减少开发测试之间的沟通成本，开发swagger邮件通知功能，如果监控到swagger有内容变更，发送通知邮件到测试组。

 

一：接口版本注释添加规则：

无论修改接口任何东西 只要修改类或方法上的版本号 邮件即会通知到测试组

swagger上所有系统接口注释添加时初始版本号为1.0.0 标名在类上

此版本号只是为了接口变更时能及时通知到测试组，无实际意义和版本迭代的版本无关

 

1.首先类和方法上都可以添加版本号 在类上添加版本号1.0.0默认此类下的所有方法都是1.0.0

2.方法上版本号优先级大于类上版本号优先级，如果只有类上有版本号假设1.0.0，类下的一个方法发生变更比如变成1.0.1 则只有此方法版本为1.0.1

  其他未标明版本的方法仍和类的版本一致，不会邮件提醒 。只有发生变更的方法会发送接口变更邮件到测试组

版本变更规则：假设初始版本号为1.0.0

1.逻辑变更 只变更第一位 第一位+1      版本号变为2.0.0  

2.参数变更 只变更第二位 第二位+1     版本号变为1.1.0

3.返回值变更 只变更第三位 第三位+1  版本号变为1.0.1

以此类推

邮件功能已修改，大家需要重启一下应用

邮件展示如下：

 

 

 

转载于:https://www.cnblogs.com/nuonuozhou/p/10297904.html