接口(Api)版本号命名规则
0. 前言
版本號的命名和更新問題,是開發者的責任感和前瞻性的問題。
1. 項目立項時
版本格式:0.0.0
2. 開發階段時
此時系統尚不穩定,隨時可能增減或者修正API。
版本格式:0.次版本號.修訂號,版本號遞增規則如下:
3. 開發完成后,發布API,或進入二方庫時
此時系統已經基本穩定,可以對外公布使用,意味著API不再會被隨意修改。
版本格式:1.0.0
4. 后續的維護升級時
沒有特殊需求不會修改API,尤其是對API進行不兼容的升級,或棄用時要特別謹慎。如果需要棄用API,要提前在一個或幾個版本中加入棄用標示或注解,并在文檔中,建議用戶更換為其他可替換的API,然后在下個主版本號升級時,再真正丟掉棄用的API。
版本格式:主版本號.次版本號.修訂號,版本號遞增規則如下:
新增接口:如果該新增的接口只是對現有的業務線進行擴展則增加修訂號;如果是為了增加新的業務線則增加次版本號。
5. 先行版本號和開發版本號
先行版本號及版本編譯信息可以加到“主版本號.次版本號.修訂號”的后面,作為延伸。
特別注意:
1. 版本一經發布,不得修改其內容,任何修改必須在新版本發布!
2. 在接口還沒有確定下來的時候,應該先使用開發版本號。
3. 業務功能 > 功能 > 接口
推薦閱讀:
版本號命名指南
版本號命名規則-語義化版本 2.0.0 | Semantic Versioning
————————————————
版權聲明:本文為CSDN博主「frcoder」的原創文章,遵循 CC 4.0 BY-SA 版權協議,轉載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/u012107143/article/details/78731272
總結
以上是生活随笔為你收集整理的接口(Api)版本号命名规则的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: python 零代码快速开发平台_现在低
- 下一篇: C# JScript.Eval使用