API接口版本控制的实现方式

管理 管理 编辑 删除

软件系统在整个生命周期当中会根据需求的不断变化进行不断的迭代更新,因此服务端对外提供的接口尽管功能未发生变化,但是实现的逻辑,代码也在不断的变化。如果只是简单的变化,对于接口调用者来说是无感知的,但是通常会出现一些突破性的变化,例如:

  • 接口新增字段
  • 接口字段类型变更
  • 接口字段由非必传变成必传

上述情况的出现,对于接口调用者来说必然是存在强烈感知的,通常为了减少接口调用者的感知,服务端代码就存在同样功能的接口,多个版本的情况,就出现了接口版本控制这个问题。

版本控制及实现方式:

1、请求参数控制

例如在HTTP请求当中不修改请求路径的情况下添加参数:

在请求的参数当中添加版本参数: HTTP://XXX.COM?version=1

在请求头HEADER当中添加版本参数:version:1

在请求头Content-Type: application/v1.json

以上三种均可以在请求参数当中进行版本的控制,并且不修改请求路径,相关代码实现如下:

   @GetMapping(value = "test",params = {"version=1"},headers = {"version=1"},consumes = {"Content-Type=application/v1.json"})
   public String getT2() {
       return "123456";
   }

2、URL路径控制

即版本是请求URL的一部分:例如:/v1/api/getUser, /api/getUser/v1。

3、域名服务控制

即请求路径不变,域名发生变化:v1.api.hjljy.cn/getUser,v2.api.hjljy.cn/getUser

总结

无论选用哪一种实现方式,同一个功能的接口版本不宜过多,避免造成较高的维护成本,同时尽可能的保证接口版本的稳定性和可读性(便于查找和排错)

CRMEB-暮白寒窗雪 最后编辑于2023-03-14 17:53:04

回复({{post_count}})
回复从新到旧

{{item.user_info.nickname}} {{item.user_info.is_threads ? '(管理员)' : item.user_id == thread_uid ? '(作者)' : ''}}

{{item.user_name}} {{item.user_info.is_threads ? '(管理员)' : item.user_id == thread_uid ? '(作者)' : ''}}

{{item.user_info.title}}
{{item.created_at}}  {{item.user_info.ip_address}}
{{item.like_count}}
{{item.showReply ? '取消回复' : '回复'}}
删除
回复

{{itemc.user_info.nickname}}

{{itemc.user_name}}

{{itemc.user_info.is_threads ? '(管理员)' : itemc.user_id == thread_uid ? '(作者)' : ''}}

回复 {{itemc.comment_user_info.nickname}}

{{itemc.created_at}}   {{itemc.user_info.ip_address}}
{{itemc.like_count}}
{{itemc.showReply ? '取消回复' : '回复'}}
删除
回复
查看更多
回复
添加回复 ({{post_count}})
152
{{like_count}}
{{collect_count}}

相关推荐

CRMEB-暮白寒窗雪 管理员
社区运营专员---高冷のBoy | 呆萌のGirl

回答

596

发布

837

经验

15071

内容精选
{{item.title}}
{{item.created_at}}
{{item.fic_view_count}}
换一批

快速安全登录

使用微信扫码登录
经验说明

1、发布新帖子,每发布一条帖子可获得20个经验,每天最多可获取200个经验;

2、发布新回复,每发布一条回复可获得10个经验,每天最多可获取200个经验;

3、发布的帖子被管理员设置为精华帖,每被加精一次可获得10个经验,无上限;

4、发布帖子被回复一条,加2个经验,无上限;

5、发布帖子被点赞一个或发布评论被点赞加5个经验,无上限;

6、论坛首页大神积分排行榜,统计90天以内获取的累积经验值进行排序。

7、技术社区经验和官方商城用户经验同步,累计经验值会提升商城会员等级,购买官方商城产品享受对应会员等级折扣

确定
{{item.label}} 首页头条 首页动态 加精 板块推荐 取 消 确 定
回复
CRMEB客服

CRMEB咨询热线 咨询热线

400-8888-794

微信扫码咨询

CRMEB开源商城下载 开源下载 CRMEB官方论坛 帮助文档
返回顶部 返回顶部
CRMEB客服