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

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

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

相关推荐

微软Win10/Win11版Copilot上线:支持OpenAI o3推理模型

IT之家4月3日消息,科技媒体WindowsLatest昨日(4月2日)发布博文,报道称Windows10、Windows11新版Copilot应用已摘掉Beta帽...

WinForm 双屏幕应用开发:原理、实现与优化

在当今的软件开发领域,多屏幕显示技术的应用越来越广泛。对于WinForm应用程序来说,能够支持双屏幕显示不仅可以提升用户体验,还能满足一些特定场景下的业务需求,比如在演示、监控或者多任务处理等场景...

推荐一个使用 C# 开发的 Windows10 磁贴美化小工具

...

OpenJDK 8 安装(openjdk 8 windows)

通常OpenJDK8和11都能互相编译和通用。我们建议使用11,但是如果你使用JDK8的话也是没有问题的。建议配置使用OpenJDK,不建议使用OracleJDK,主要是因为版...

基于 Linux 快速部署 OpenConnect VPN 服务(ocserv 实战指南)

一、前言在如今远程办公和内网穿透需求日益增长的背景下,搭建一套安全、稳定、高效的VPN系统显得尤为重要。OpenConnectServer(ocserv)是一个开源、高性能的VPN服务端软件...

巧妙设置让Edge浏览器更好用(edge怎么设置好用)

虽然现在新版本的Edge浏览器已经推出,但是毕竟还处于测试的状态中。而Win10系统里面自带的老版Edge浏览器,却越来越不被人重视。其实我们只需要根据实际情况对老版本的Edge浏览器进行一些简单的设...

WPF做一个漂亮的登录界面(wpf页面设计)

...

微软开源博客工具Open Live Writer更新:多项Bug修复

OpenLiveWriter前身是WindowsLiveWriter,是微软WindowsLive系列软件之一,曾经是博主们非常喜爱的一款所见即所得博文编辑工具,支持离线保存,还支持图像编辑...

基于OpenVINO的在线设计和虚拟试穿 | OPENAIGC大赛企业组优秀作品

在第二届拯救者杯OPENAIGC开发者大赛中,涌现出一批技术突出、创意卓越的作品。为了让这些优秀项目被更多人看到,我们特意开设了优秀作品报道专栏,旨在展示其独特之处和开发者的精彩故事。...

C#开源免费的Windows右键菜单管理工具

...

Windows10或11中隐藏的功能,用它再也不用担心电脑中病毒!

...

Python open函数详解(python open函数源码)

演示环境,操作系统:Win1021H2(64bit);Python解释器:3.8.10。open是Python的一个内置函数,一般用于本地文件的读写操作。用法如下。my_file=open(fi...

Windows 11 安装 Docker Desktop(Windows 11 安装助手 Windows 易升 关系)

...

Windows 11 新版发布:屏幕亮度自适应控制,小组件界面重新设计!

...

世界上最好用的Linux发行版之一,OpenSUSE安装及简单体验

背景之前无意在论坛里看到openSUSE的Linux发行版,被称为世界上最好用的Linux发行版之一(阔怕),一直想体验一下,于是这期做一个安装和简单体验教程吧。...

取消回复欢迎 发表评论: