其他分享
首页 > 其他分享> > API 版本控制小技巧

API 版本控制小技巧

作者:互联网

在 Spring 项目的控制器中,有 2 个 Rest API 方法。例如


- 获取用户接口:/user/getUserInfo


- 获取权限接口:/role/getRoleList


一个客户端正在通过 /api/v1进行访问


现在想更新其中一种方法。即/user/getRoleList;因此新方法的版本将为 / api/v2 。但是 v1 的方法没有变化,即 /api/v1 。


如何在同一项目中使用两个版本处理其余方法呢?


意思是 /user/getUserInfo 接口应该同时支持 /api/v1 和 /api/v2。并且 /role/getRoleList 也应该应该支持两个版本,但是功能不同。简单的说


/user/getUserInfo 将有1个方法同时支持两个版本


每个版本的 /role/getRoleList 将有2个方法


如果要对两个版本使用单独的方法,可以通过在 @RequestMapping 中定义不同的值


# 方案一:使用两个接口

```

 @RequestMapping(value = "/v1/role/getRoleList",

     method = RequestMethod.GET,

     produces = MediaType.APPLICATION_JSON_VALUE)

```

```

@RequestMapping(value = "/v2/role/getRoleList",

      method = RequestMethod.GET,

      produces = MediaType.APPLICATION_JSON_VALUE)

```

如果要使用相同的方法来处理,则可以使用方案二


# 方案二:使用@PathVariable

```

@RequestMapping(value = "/{version}/role/getRoleList",

       method = RequestMethod.GET,

     produces = MediaType.APPLICATION_JSON_VALUE)

public returnType methodName(@PathVariable("version") String version){

        // code to check version

}

```

# 方案三:使用@RequestHeader

```

@RequestMapping(value = "/role/getRoleList",

     method = RequestMethod.GET,

     produces = MediaType.APPLICATION_JSON_VALUE)

public returnType methodName(@RequestHeader("version") String version){

    // code to check version

}

```

一般更喜欢在类级别使用 @RequestMapping 单独的控制器中进行管理


# 方案四:使用两个类进行单独映射

```

@RestController@RequestMapping("/v1")

public class RoleV1Controller {


     @RequestMapping(value = "/role/getRoleList",

        method = RequestMethod.GET,

        produces = MediaType.APPLICATION_JSON_VALUE)

      public returnType methodName(){


       }


@RestController@RequestMapping("/v2")

public class RoleV2Controller {


     @RequestMapping(value = "/role/getRoleList",

        method = RequestMethod.GET,

        produces = MediaType.APPLICATION_JSON_VALUE)

      public returnType methodName(){


       }


}

```



标签:版本控制,技巧,produces,MediaType,getRoleList,API,role,version,RequestMapping
来源: https://blog.51cto.com/u_13538361/2743622