公司项目JAVA开发规范总结（二）——接口REST风格规范

二、接口REST风格规范

概论：REST是一种软件架构风格，全称是表述性状态传递。体现在Web开发中就是通过HTTP方法中的POST、DELETE、PUT、GET来对资源进行操作。

RESTful的URL风格例子如下：

查询：/users/1 （GET）
新增：/users （POST）
修改：/users/1 （PUT）
删除：/users/1 （DELETE）

RESTful风格的基本规则：

简单来讲就是：
1、看URL就知道要操作什么
2、看HTTP方法就知道要如何操作
3、看HTTP状态码就知道返回结果如何

JAVA代码例子：

//正确例子
@GetMapping(value = "{groupId}")
@ApiOperation(value = "获取当前团信息",notes = "拼团详情页用。")
public PacketHttpRes_V32<T> groupDetail(@ApiParam("团ID") @PathVariable("groupId")Long groupId){
	return PacketHttpRes_V32.makeOKResponse(groupService.getGroupByCache(groupId));
}

//错误例子
@GetMapping("GetGroupById")
@ApiOperation(value = "获取当前团信息",notes = "拼团详情页用。")
public PacketHttpRes_V32<T> groupDetail(@ApiParam("团ID") @RequestParam(value ="groupId")Long groupId){
	return PacketHttpRes_V32.makeOKResponse(groupService.getGroupByCache(groupId));
}