【Spring Boot】构建RESTful服务 — 实战：实现Web API版本控制

实战：实现Web API版本控制

前面介绍了Spring Boot如何构建RESTful风格的Web应用接口以及使用Swagger生成API的接口文档。如果业务需求变更，Web API功能发生变化时应该如何处理呢？可以通过Web API的版本控制来处理。

1.为什么进行版本控制

一般来说，Web API是提供给其他系统或其他公司使用的，不能随意频繁地变更。然而，由于需求和业务不断变化，Web API也会随之不断修改。如果直接对原来的接口修改，势必会影响其他系统的正常运行。

例如，系统中用户添加的接口/api/user由于业务需求的变化，接口的字段属性也发生了变化，而且可能与之前的功能不兼容。为了保证原有的接口调用方不受影响，只能重新定义一个新的接口：/api/user2，这使得接口维护难度增加。

如何做到在不影响现有调用方的情况下，优雅地更新接口的功能呢？

最简单高效的办法就是对Web API进行有效的版本控制。通过增加版本号来区分对应的版本，来满足各个接口调用方的需求。版本号的使用有以下几种方式：

1）通过域名进行区分，即不同的版本使用不同的域名，如v1.api.test.com、v2.api.test.com。

2）通过请求URL路径进行区分，在同一个域名下使用不同的URL路径，如test.com/api/v1/、test.com/api/v2。

3）通过请求参数进行区分，在同一个URL路径下增加version=v1或v2等，然后根据不同的版本选择执行不同的方法。

在实际项目开发中，一般选择