0. 前言

版本號的命名和更新問題，是開發(fā)者的責任感和前瞻性的問題。

1. 項目立項時

版本格式：0.0.0

2. 開發(fā)階段時

此時系統(tǒng)尚不穩(wěn)定，隨時可能增減或者修正API。

版本格式：0.次版本號.修訂號，版本號遞增規(guī)則如下：

主版本號：0表示正在開發(fā)階段；

次版本號：增加新的功能時增加；

修訂號：只要有改動就增加。

3. 開發(fā)完成后，發(fā)布API，或進入二方庫時

此時系統(tǒng)已經(jīng)基本穩(wěn)定，可以對外公布使用，意味著API不再會被隨意修改。

版本格式：1.0.0

4. 后續(xù)的維護升級時

沒有特殊需求不會修改API，尤其是對API進行不兼容的升級，或棄用時要特別謹慎。如果需要棄用API，要提前在一個或幾個版本中加入棄用標示或注解，并在文檔中，建議用戶更換為其他可替換的API，然后在下個主版本號升級時，再真正丟掉棄用的API。

版本格式：主版本號.次版本號.修訂號，版本號遞增規(guī)則如下：

主版本號：全盤重構(gòu)時增加；重大功能或方向改變時增加；大范圍不兼容之前的接口時增加；

次版本號：增加新的業(yè)務(wù)功能時增加；

修訂號：增加新的接口時增加；在接口不變的情況下，增加接口的非必填屬性時增加；增強和擴展接口功能時增加。

新增接口：如果該新增的接口只是對現(xiàn)有的業(yè)務(wù)線進行擴展則增加修訂號；如果是為了增加新的業(yè)務(wù)線則增加次版本號。

5. 先行版本號和開發(fā)版本號

先行版本號及版本編譯信息可以加到“主版本號.次版本號.修訂號”的后面，作為延伸。

先行版本號(Pre-release)：意味該版本不穩(wěn)定，可能存在兼容性問題。 其格式為：X.Y.Z.[a-c][正整數(shù)]，如 1.0.0.a1，1.0.0.b99，1.0.0.c1000。

開發(fā)版本號：常用于 CI-CD（持續(xù)集成和持續(xù)交付）。 格式為 X.Y.Z-dev[正整數(shù)]，如 1.0.1-dev4。

版本號的排序規(guī)則為依次比較主版本號、次版本號和修訂號的數(shù)值，如 1.0.0 < 1.0.1 < 1.1.1 < 2.0.0；對于先行版本號和開發(fā)版本號，有：1.0.0.a100 < 1.0.0，2.1.0-dev3 < 2.1.0；當存在字母時，以 ASCII 的排序來比較，如 1.0.0.a1 < 1.0.0.b1。

特別注意：

1. 版本一經(jīng)發(fā)布，不得修改其內(nèi)容，任何修改必須在新版本發(fā)布！
2. 在接口還沒有確定下來的時候，應(yīng)該先使用開發(fā)版本號。
3. 業(yè)務(wù)功能 > 功能 > 接口

推薦閱讀：
版本號命名指南
版本號命名規(guī)則-語義化版本 2.0.0 | Semantic Versioning

————————————————
版權(quán)聲明：本文為CSDN博主「frcoder」的原創(chuàng)文章，遵循 CC 4.0 BY-SA 版權(quán)協(xié)議，轉(zhuǎn)載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/u012107143/article/details/78731272

總結(jié)

以上是生活随笔為你收集整理的接口（Api）版本号命名规则的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。