關於java的接口的一些規范


一、Api請求及響應規范 為了嚴格按照接口進行開發,提高效率,對請求及響應格式進行規范化。

1、get 請求時,采用key/value格式請求,SpringMVC可采用基本類型的變量接收,也可以采用對象接收。

2、Post請求時,

  可以提交form表單數據(application/x-www-form-urlencoded);

  Json數據(ContentType=application/json);

  文件等多部件類型(multipart/form-data)三種數據格式;

3、SpringMVC接收Json數據 使用@RequestBody注解解析請求的json數據。

4、響應結果統一信息為:是否成功、操作代碼、提示信息及自定義數據。

5、響應結果統一格式為json。

二、Api定義約束

Api定義使用SpringMVC來完成,由於此接口后期將作為微服務遠程調用使用,在定義接口時有如下限制:

1、@PathVariable 統一指定參數名稱,如:@PathVariable("id")

2、@RequestParam統一指定參數名稱,如: @RequestParam("id")


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM