介面規範

最新公司新的專案,使用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?id=x232323

規範

HTTP 協議是不區分大小寫的,所有不需要使用駝峰式
http://www.xxx.com/getbyregionId?id=x232323
單詞要使用英文來命名，不要拼音英文混合,不要英文簡寫,除非這個簡寫大家都認識
同一名稱不同人名稱要相同
名稱可以長一些,單不要有歧義