6.5 拓展：如何实现 Web API 版本控制，同时兼容无版本控制的原始接口？

今天药忘吃喽~ 2023-10-08 18:16 21阅读 0赞

> ## 第6章 构建 RESTful 服务 ##
> 
> 6.1 [RESTful 简介][RESTful]  
> 6.2 [构建 RESTful 应用接口][RESTful 1]  
> 6.3 [使用 Swagger 生成 Web API 文档][Swagger _ Web API]  
> 6.4 [实战：实现 Web API 版本控制][Web API]  
> 6.5 [拓展：如何实现 Web API 版本控制，同时兼容无版本控制的原始接口？][Web API 1]

### 6.5 拓展：如何实现 Web API 版本控制，同时兼容无版本控制的原始接口？ ###

#### 〇、背景 ####

在上一节 [6.4 实战：实现 Web API 版本控制][Web API] 中，我们实现了 Web API 版本控制，但是有一个问题：我们在原始版本上增加了版本控制之后（假设原始版本没有版本号，现在做版本控制之后，V1对应了原始版本），可以正常访问有版本号的接口，但是却无法访问没有版本号的原始接口。如下：

>  *  原始版本（无版本控制）删除订单接口：http://localhost:8080/api/order/delete/20011（无法返回数据）  
>     ![原始版本（无版本控制）删除订单接口][1b74f81900734c27a1316e03e65aad3c.png]
>  *  原始版本（无版本控制）获取订单详情接口：http://localhost:8080/api/order/detail/20011（无法返回数据）  
>     ![原始版本（无版本控制）获取订单详情接口][443d7e9787c74ef680d90004005ddbd7.png]

#### 一、需求 ####

假设原始 Web API 接口没有实现版本控制，那么，如何升级接口才能在实现版本控制的同时，无版本控制的原始接口不受影响。

> 1、背景  
> 假设 原始接口（无版本控制） 和 升级后的接口（有版本控制） 如下所示。
> 
>  *  **原始接口（无版本控制）：**  
>     `api/order/接口名称`
>  *  **升级后的接口（有版本控制）：**  
>     `api/v1/order/接口名称`  
>     `api/v2/order/接口名称`
> 
> 2、核心需求：  
> （1）升级接口，进行 Web API 版本控制。  
> （2）原始接口可以正常访问，不受接口升级影响。  
> （3）原始接口和升级后的V1接口等价（即`api/order/接口名称`和`api/v1/order/接口名称`等价）。

#### 二、解决方案 ####

> Spring Boot 对 RESTful 的支持非常全面，因而实现 RESTful API 非常简单，同样对于 API 版本控制也有相应的实现方案，实现步骤如下：
> 
> **1、API版本控制配置**
> 
> （1）创建自定义的 @ApiVersion 注解。
> 
> （2）创建自定义 URL 匹配规则 ApiVersionCondition 类（实现 RequestCondition 接口）。
> 
> （3）创建自定义的映射处理程序 ApiRequestMappingHandlerMapping 类（继承 RequestMappingHandlerMapping 类）。
> 
> （4）创建 WebMvcRegistrationsConfig 配置类（实现 WebMvcRegistrations 接口），将自定义的映射处理程序 ApiRequestMappingHandlerMapping 注册到系统中。
> 
> **2、配置实现接口**
> 
> 编写测试的控制器，实现相关接口的测试。
> 
> > 假设升级后的接口为V1（版本1）、V2（版本2）。  
> > 实现方法：
> > 
> >  *  原始接口：原始接口不需要做任何操作。（保证原始接口不受任何影响）
> >  *  V1接口：V1接口不需要实现任何接口，直接继承原始接口，然后添加版本注解@ApiVersion 和 URL中添加版本标志\{version\} 实现版本控制即可。（保证原始接口和升级后的V1接口等价）
> >  *  V2接口：V2接口根据业务需求的变化实现相关接口，然后添加版本注解@ApiVersion 和 URL中添加版本标志\{version\} 实现版本控制。

#### 三、具体实现 ####

##### 1、API版本控制配置 #####

关于 API版本控制配置，可以直接参考上一节 [6.4 实战：实现 Web API 版本控制][Web API] 。

##### 2、配置实现接口 #####

配置完成之后，接下来编写测试的控制器（Controller），实现相关接口的测试。在 Controller 目录下分别创建 OrderV1Controller 和 OrderV2Controller，原始接口控制器 OrderController 不做任何改动。示例代码如下：

OrderController.java

package com.example.restfulproject

[RESTful]: https://blog.csdn.net/Shipley_Leo/article/details/129090115
[RESTful 1]: https://blog.csdn.net/Shipley_Leo/article/details/129093550
[Swagger _ Web API]: https://blog.csdn.net/Shipley_Leo/article/details/129110193
[Web API]: https://blog.csdn.net/Shipley_Leo/article/details/129132778
[Web API 1]: https://blog.csdn.net/Shipley_Leo/article/details/129179577
[1b74f81900734c27a1316e03e65aad3c.png]: https://img-blog.csdnimg.cn/1b74f81900734c27a1316e03e65aad3c.png
[443d7e9787c74ef680d90004005ddbd7.png]: https://img-blog.csdnimg.cn/443d7e9787c74ef680d90004005ddbd7.png

发表评论取消回复

表情：

评论列表（有 0 条评论，21人围观）

还没有评论，来说两句吧...

相关阅读

相关 6.5 拓展：如何实现 Web API 版本控制，同时兼容无版本控制的原始接口？

> 第6章构建 RESTful 服务 > > 6.1 [RESTful 简介][RESTful] > 6.2 [构建 RESTful 应用接口][RESTful 1

今天药忘吃喽~/ 2023年10月08日 18:16/ 0 赞/ 22 阅读

相关 6.4 实战：实现 Web API 版本控制

> 第6章构建 RESTful 服务 > > 6.1 [RESTful 简介][RESTful] > 6.2 [构建 RESTful 应用接口][RESTful 1

ゝ一世哀愁。/ 2023年10月08日 18:01/ 0 赞/ 32 阅读

相关移动app开发如何做接口的版本控制

移动app为什么要做版本控制应用升级无法做到全部升级。比如某应用现行1.1版本，某次开发升级后，版本变为1.2。除app界面变化外，后台接口也发生了变化。然而不是所有的

比眉伴天荒/ 2023年10月06日 12:38/ 0 赞/ 11 阅读

相关 RESTful API如何进行版本控制

本文将帮助您理解为什么需要版本控制，以及如何对REST API进行版本控制。我们将讨论4种版本控制的方法，并比较不同的方法。您将学到为什么我们需要对RESTful

骑猪看日落/ 2023年01月11日 04:59/ 0 赞/ 168 阅读

相关 SpringBoot API版本控制

欢迎使用Markdown编辑器写博客后端开发人员经常遇到接口升级、优化接口甚至重新定义一模一样新接口而且还得兼容旧版本接口。这样我们得维护两个一模一样接口，版本管理越来

落日映苍穹つ/ 2022年10月24日 01:36/ 0 赞/ 224 阅读

相关提问：版本控制hg，如何对文件夹进行版本控制？

问朋友们一个问题，最近在开发个人项目，本人是个版本控制控，怎么都要弄个版本控制器，但是自己搭建svn server一个是不能异地使用，另外一个限于存储空间的问题，开始对git感

浅浅的花香味﹌/ 2022年09月29日 06:03/ 0 赞/ 262 阅读

相关 Spring Boot入门如何优雅的设计 Restful API 接口版本号，实现 API 版本控制

前面介绍了Spring Boot 如何快速实现Restful api 接口，并以人员信息为例，设计了一套操作人员信息的接口。不清楚的可以看之前的文章：https://www.c

我就是我/ 2022年09月10日 01:16/ 0 赞/ 42 阅读

相关 Web API 版本控制的几种方式

这篇文章写得很好，介绍了三种实现web api版本化的三种方式。我从评论里又收集到两种方式，所以一共是5种：方式一：利用URL \[html\] [view plain

Bertha 。/ 2022年08月05日 02:43/ 0 赞/ 217 阅读

相关 ~ ^ 版本控制

^version 更新到当前 major version（也就是第一位数字）中最新的版本 > 从左数，第1个不为 0 的数字 + 1，后面的变成 0 ^1.2

雨点打透心脏的1/2处/ 2021年09月18日 23:30/ 0 赞/ 440 阅读

相关版本控制

文章目录 * 什么是版本控制版本控制的作用版本控制系统分类 * 本地版本控制系统 * 集...

小灰灰/ 2020年06月13日 06:08/ 0 赞/ 906 阅读