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

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

yuyutoo 2025-02-15 18:05 5 浏览 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 版本控制。

相关推荐

墨尔本一华裔男子与亚裔男子分别失踪数日 警方寻人

中新网5月15日电据澳洲新快网报道,据澳大利亚维州警察局网站消息,22岁的华裔男子邓跃(Yue‘Peter’Deng,音译)失踪已6天,维州警方于当地时间13日发布寻人通告,寻求公众协助寻找邓跃。华...

网络交友须谨慎!美国犹他州一男子因涉嫌杀害女网友被捕

伊森·洪克斯克(图源网络,侵删)据美国广播公司(ABC)25日报道,美国犹他州一名男子于24日因涉嫌谋杀被捕。警方表示,这名男子主动告知警局,称其杀害了一名在网络交友软件上认识的25岁女子。雷顿警...

一课译词:来龙去脉(来龙去脉 的意思解释)

Mountainranges[Photo/SIPA]“来龙去脉”,汉语成语,本指山脉的走势和去向,现比喻一件事的前因后果(causeandeffectofanevent),可以翻译为“i...

高考重要考点:range(range高考用法)

range可以用作动词,也可以用作名词,含义特别多,在阅读理解中出现的频率很高,还经常作为完形填空的选项,而且在作文中使用是非常好的高级词汇。...

C++20 Ranges:现代范围操作(现代c++白皮书)

1.引言:C++20Ranges库简介C++20引入的Ranges库是C++标准库的重要更新,旨在提供更现代化、表达力更强的方式来处理数据序列(范围,range)。Ranges库基于...

学习VBA,报表做到飞 第二章 数组 2.4 Filter函数

第二章数组2.4Filter函数Filter函数功能与autofilter函数类似,它对一个一维数组进行筛选,返回一个从0开始的数组。...

VBA学习笔记:数组:数组相关函数—Split,Join

Split拆分字符串函数,语法Split(expression,字符,Limit,compare),第1参数为必写,后面3个参数都是可选项。Expression为需要拆分的数据,“字符”就是以哪个字...

VBA如何自定义序列,学会这些方法,让你工作更轻松

No.1在Excel中,自定义序列是一种快速填表机制,如何有效地利用这个方法,可以大大增加工作效率。通常在操作工作表的时候,可能会输入一些很有序的序列,如果一一录入就显得十分笨拙。Excel给出了一种...

Excel VBA入门教程1.3 数组基础(vba数组详解)

1.3数组使用数组和对象时,也要声明,这里说下数组的声明:'确定范围的数组,可以存储b-a+1个数,a、b为整数Dim数组名称(aTob)As数据类型Dimarr...

远程网络调试工具百宝箱-MobaXterm

MobaXterm是一个功能强大的远程网络工具百宝箱,它将所有重要的远程网络工具(SSH、Telnet、X11、RDP、VNC、FTP、MOSH、Serial等)和Unix命令(bash、ls、cat...

AREX:携程新一代自动化回归测试工具的设计与实现

一、背景随着携程机票BU业务规模的不断提高,业务系统日趋复杂,各种问题和挑战也随之而来。对于研发测试团队,面临着各种效能困境,包括业务复杂度高、数据构造工作量大、回归测试全量回归、沟通成本高、测试用例...

Windows、Android、IOS、Web自动化工具选择策略

Windows平台中应用UI自动化测试解决方案AutoIT是开源工具,该工具识别windows的标准控件效果不错,但是当它遇到应用中非标准控件定义的UI元素时往往就无能为力了,这个时候选择silkte...

python自动化工具:pywinauto(python快速上手 自动化)

简介Pywinauto是完全由Python构建的一个模块,可以用于自动化Windows上的GUI应用程序。同时,它支持鼠标、键盘操作,在元素控件树较复杂的界面,可以辅助我们完成自动化操作。我在...

时下最火的 Airtest 如何测试手机 APP?

引言Airtest是网易出品的一款基于图像识别的自动化测试工具,主要应用在手机APP和游戏的测试。一旦使用了这个工具进行APP的自动化,你就会发现自动化测试原来是如此简单!!连接手机要进行...

【推荐】7个最强Appium替代工具,移动App自动化测试必备!

在移动应用开发日益火爆的今天,自动化测试成为了确保应用质量和用户体验的关键环节。Appium作为一款广泛应用的移动应用自动化测试工具,为测试人员所熟知。然而,在不同的测试场景和需求下,还有许多其他优...

取消回复欢迎 发表评论: