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
以此類推
郵件功能已修改,大家需要重啟一下應用
郵件展示如下:
 
 
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM