后台API接口规范

接口规范

最新公司新的项目,使用spring boot,cloud,服务之间使用rest api进行调用,所有使用了restful 风格的接口

@RequestMapping(value = "/getByRegionId/{regionId}", method = RequestMethod.GET)
@ResponseBody
public ObjectRestResponse<List<RegionsDTO>> getByRegionId(@PathVariable("regionId") String regionId) {}

@RequestMapping(value = "/{id}/menu", method = RequestMethod.POST)
@ResponseBody
public ObjectRestResponse modifyMenuAuthority(@PathVariable String id) {}

restful 风格接口的利弊

利:接口名称相同,请求method,通过RequestMethod.GET/POST/PUT/DELETE来区别,就可以实现增删改查
弊:前端传参不方便,如http://www.xxx.com/getByRegionId/x232323,在请求地址中拼接,如果regionId为空,就会出错.

其他方式:

如http://www.xxx.com/getByRegionId ,通过表单参数POST,或GET地址栏参数传regionId,如

http://www.xxx.com/getByRegionId?id=x232323

规范

HTTP 协议是不区分大小写的,所有不需要使用驼峰式
http://www.xxx.com/getbyregionId?id=x232323
单词要使用英文来命名，不要拼音英文混合,不要英文简写,除非这个简写大家都认识
同一名称不同人名称要相同
名称可以长一些,单不要有歧义