百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

关于API接口兼容性的一点思考

yuyutoo 2025-02-15 18:05 1 浏览 0 评论

如果只是编写一个简单的脚本,我们很少会思考接口的兼容性问题。但如果是涉及一个大型的分布式系统,里面包括了很多微服务,服务之间相互调用,那么接口兼容性就是必须要考虑的一个因素。一个成熟产品的一个标志性特征就是对外有一套稳定的API,这里的稳定不仅指的是服务本身SLA,对服务的调用者来说,接口必须是兼容的。

比如下面的场景,服务A 调用 服务B ,当升级服务B 到新版的时候,A服务调用不受影响,这就叫向后兼容,我们在大分部开发上线的时候,都需要保持接口的向后兼容。

那么什么是向前兼容呢? 向前意思就是向之前的接口兼容,比如我们升级了新版本,而且产生了一些数据,此时,如果我们回滚服务B,老版本的服务B 仍然可以正常提供服务。

理想状况下,我们需要做到接口的向前和向后兼容。为了保持接口的向后兼容,我们通常:

  1. 为类(结构体)新加字段提供默认值,保持兼容
  2. 绝对不要重命名或者删除字段
  3. 绝对不要把一个可选字段设置为必选
  4. 如果老的API不用了,就标记为过时
  5. 可以用老版本的数据,测试新接口的兼容性

如果是向前兼容,老代码遇到新字段的时候,只要做到忽略不报错即可。

现实毕竟不是理想,当我们遇到大的改动,必须升级新版本的时候。我们需要对接口有严格的版本控制。

当无法实现兼容,我们必须升级接口的版本号,比如/v1/users 升级到 v2/users 。

当只是小改动,我们可以升级一个小的版本号,比如 /v1/users 升级到 v1.1/users。

我比较建议使用上面的方式,不过社区里面也经常看到使用mine 的方式定义版本号的,比如docker镜像的格式有很多种,通过在header Content-Type里面的mine 去区分,比如下面不同格式的镜像。

application/vnd.oci.image.layer.v1.tar, 
application/vnd.oci.image.layer.v1.tar+gzip,
application/vnd.oci.image.layer.v1.tar+zstd

但这会让api 接口变的复杂,所以我更加推进API 版本控制。

相关推荐

史上最全的浏览器兼容性问题和解决方案

微信ID:WEB_wysj(点击关注)◎◎◎◎◎◎◎◎◎一┳═┻︻▄(页底留言开放,欢迎来吐槽)●●●...

平面设计基础知识_平面设计基础知识实验收获与总结
平面设计基础知识_平面设计基础知识实验收获与总结

CSS构造颜色,背景与图像1.使用span更好的控制文本中局部区域的文本:文本;2.使用display属性提供区块转变:display:inline(是内联的...

2025-02-21 16:01 yuyutoo

写作排版简单三步就行-工具篇_作文排版模板

和我们工作中日常word排版内部交流不同,这篇教程介绍的写作排版主要是用于“微信公众号、头条号”网络展示。写作展现的是我的思考,排版是让写作在网格上更好地展现。在写作上花费时间是有累积复利优势的,在排...

写一个2048的游戏_2048小游戏功能实现

1.创建HTML文件1.打开一个文本编辑器,例如Notepad++、SublimeText、VisualStudioCode等。2.将以下HTML代码复制并粘贴到文本编辑器中:html...

今天你穿“短袖”了吗?青岛最高23℃!接下来几天气温更刺激……

  最近的天气暖和得让很多小伙伴们喊“热”!!!  昨天的气温到底升得有多高呢?你家有没有榜上有名?...

CSS不规则卡片,纯CSS制作优惠券样式,CSS实现锯齿样式

之前也有写过CSS优惠券样式《CSS3径向渐变实现优惠券波浪造型》,这次再来温习一遍,并且将更为详细的讲解,从布局到具体样式说明,最后定义CSS变量,自定义主题颜色。布局...

柠檬科技肖勃飞:大数据风控助力信用社会建设

...

你的自我界限够强大吗?_你的自我界限够强大吗英文

我的结果:A、该设立新的界限...

行内元素与块级元素,以及区别_行内元素和块级元素有什么区别?

行内元素与块级元素首先,CSS规范规定,每个元素都有display属性,确定该元素的类型,每个元素都有默认的display值,分别为块级(block)、行内(inline)。块级元素:(以下列举比较常...

让“成都速度”跑得潇潇洒洒,地上地下共享轨交繁华
让“成都速度”跑得潇潇洒洒,地上地下共享轨交繁华

去年的两会期间,习近平总书记在参加人大会议四川代表团审议时,对治蜀兴川提出了明确要求,指明了前行方向,并带来了“祝四川人民的生活越来越安逸”的美好祝福。又是一年...

2025-02-21 16:00 yuyutoo

今年国家综合性消防救援队伍计划招录消防员15000名

记者24日从应急管理部获悉,国家综合性消防救援队伍2023年消防员招录工作已正式启动。今年共计划招录消防员15000名,其中高校应届毕业生5000名、退役士兵5000名、社会青年5000名。本次招录的...

一起盘点最新 Chrome v133 的5大主流特性 ?

1.CSS的高级attr()方法CSSattr()函数是CSSLevel5中用于检索DOM元素的属性值并将其用于CSS属性值,类似于var()函数替换自定义属性值的方式。...

竞走团体世锦赛5月太仓举行 世界冠军杨家玉担任形象大使

style="text-align:center;"data-mce-style="text-align:...

学物理能做什么?_学物理能做什么 卢昌海

作者:曹则贤中国科学院物理研究所原标题:《物理学:ASourceofPowerforMan》在2006年中央电视台《对话》栏目的某期节目中,主持人问过我一个的问题:“学物理的人,如果日后不...

你不知道的关于这只眯眼兔的6个小秘密
你不知道的关于这只眯眼兔的6个小秘密

在你们忙着给熊本君做表情包的时候,要知道,最先在网络上引起轰动的可是这只脸上只有两条缝的兔子——兔斯基。今年,它更是迎来了自己的10岁生日。①关于德艺双馨“老艺...

2025-02-21 16:00 yuyutoo

取消回复欢迎 发表评论: