接口(Api)版本号命名规则

接口(Api)版本号命名规则0.前言版本号的命名和更新问题,是开发者的责任感和前瞻性的问题。1.项目立项时版本格式:0.0.02.开发阶段时此时系统尚不稳定,随时可能增减或者修正API。版本格式:0.次版本号.修订号,版本号递增规则如下:主版本号:0表示正在开发阶段;次版本号:增加新的功能时增加;修订号:只要有改动就增加。3.开发完成后,发布API,或进入二方库时此时系统已经基本稳定…

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

0. 前言

版本号的命名和更新问题,是开发者的责任感和前瞻性的问题。

1. 项目立项时

版本格式:0.0.0

2. 开发阶段时

此时系统尚不稳定,随时可能增减或者修正API。

版本格式:0.次版本号.修订号,版本号递增规则如下:

  1. 主版本号:0表示正在开发阶段;
  2. 次版本号:增加新的功能时增加;
  3. 修订号:只要有改动就增加。

3. 开发完成后,发布API,或进入二方库时

此时系统已经基本稳定,可以对外公布使用,意味着API不再会被随意修改。

版本格式:1.0.0

4. 后续的维护升级时

没有特殊需求不会修改API,尤其是对API进行不兼容的升级,或弃用时要特别谨慎。如果需要弃用API,要提前在一个或几个版本中加入弃用标示或注解,并在文档中,建议用户更换为其他可替换的API,然后在下个主版本号升级时,再真正丢掉弃用的API。

版本格式:主版本号.次版本号.修订号,版本号递增规则如下:

  1. 主版本号:全盘重构时增加;重大功能或方向改变时增加;大范围不兼容之前的接口时增加;
  2. 次版本号:增加新的业务功能时增加;
  3. 修订号:增加新的接口时增加;在接口不变的情况下,增加接口的非必填属性时增加;增强和扩展接口功能时增加。

新增接口:如果该新增的接口只是对现有的业务线进行扩展则增加修订号;如果是为了增加新的业务线则增加次版本号。

5. 先行版本号和开发版本号

先行版本号及版本编译信息可以加到“主版本号.次版本号.修订号”的后面,作为延伸。

  1. 先行版本号(Pre-release):意味该版本不稳定,可能存在兼容性问题。 其格式为:X.Y.Z.[a-c][正整数],如 1.0.0.a1,1.0.0.b99,1.0.0.c1000。
  2. 开发版本号:常用于 CI-CD(持续集成和持续交付)。 格式为 X.Y.Z-dev[正整数],如 1.0.1-dev4。
  3. 版本号的排序规则为依次比较主版本号、次版本号和修订号的数值,如 1.0.0 < 1.0.1 < 1.1.1 < 2.0.0;对于先行版本号和开发版本号,有:1.0.0.a100 < 1.0.0,2.1.0-dev3 < 2.1.0;当存在字母时,以 ASCII 的排序来比较,如 1.0.0.a1 < 1.0.0.b1。

特别注意:

1. 版本一经发布,不得修改其内容,任何修改必须在新版本发布!
2. 在接口还没有确定下来的时候,应该先使用开发版本号。
3. 业务功能 > 功能 > 接口

推荐阅读:
版本号命名指南
版本号命名规则-语义化版本 2.0.0 | Semantic Versioning

————————————————
版权声明:本文为CSDN博主「frcoder」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/u012107143/article/details/78731272

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/195110.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • 玩玩webgame开发(4):游戏数据结构设计[通俗易懂]

    玩玩webgame开发(4):游戏数据结构设计[通俗易懂]很久没做更新了。最近比较忙碌,手头的webgame也都放下。最近很想念我的小webgame了,回来继续写。上篇玩玩webgame开发(3):自动战斗实现以及一些游戏细节(下)http://playfish.iteye.com/blog/267275在高峰期时候发表的,结果被火速沉底了。。。汗好了,不小心有说了好多废话,言归正传。=============数据结构设计是门…

    2022年6月2日
    37
  • windows7如何关闭445端口_win10重装win7的后果

    windows7如何关闭445端口_win10重装win7的后果勒索病毒最新变种2.0已导致我国的很多行业遭受袭击。勒索病毒是通过入侵端口传播,主要是445端口,用户可以通过关闭445端口可以有效预防勒索病毒。下面重点介绍如何关闭445端口。关闭445端口方法图文教程方法一:使用工具一键关闭使用一键关闭445端口软件,下载本工具可以查看计算机开放端口列表及一键关闭445端口方法二:注册表首先,来查看下系统当前都开放了什么端口,怎样查看呢?调出cmd命令行程序,…

    2022年10月16日
    0
  • Linux -bash: redis-cli: command not found(亲测可行)

    Linux -bash: redis-cli: command not found(亲测可行)

    2022年2月8日
    54
  • 令牌桶的实现_C语言实现栈

    令牌桶的实现_C语言实现栈接上篇。Guava的令牌桶的实现中,包括一条设计哲学,需要大家注意:它允许瞬间的流量波峰超过QPS,但瞬间过后的请求将会等待较长的时间来缓解上次的波峰,以使得平均的QPS等于预定值。RateLimiter类提供了令牌桶的接口,它是一个抽象类,其子类有SmoothRateLimiter(也是个抽象类)以及孙子类SmoothBursty,SmoothWarmingUp。SmoothRateLimite…

    2022年8月30日
    0
  • PotPlayer+SVP4视频补帧简易教程

    PotPlayer+SVP4视频补帧简易教程这两天突然想到之前看到过视频补帧的测试,印象中效果挺好。昨天试了试,也找过很多找教程,搜集了一些经验,这里先讲解一种特别简单的方法,再说一种不太简单但也很容易上手的方法(这个才是重点!!!)。要用到的软件:Potplayer–依照你系統位数(现在基本都是64位的),不清楚就裝32bitSVP4Free-依照Potplayer安裝版本進行安裝接下来是安装:1.Potpla…

    2022年7月12日
    25
  • Python Flask,Json,返回Json数据,jsonify

    Python Flask,Json,返回Json数据,jsonify demo.py(返回Json数据):#coding:utf-8fromflaskimportFlask,jsonifyimportjsonapp=Flask(__name__)#第一种方式:手动返回Json字符串@app.route("/index")defindex():data={"name":"pytho…

    2022年5月22日
    34

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号