一、Api請求及響應(yīng)規(guī)范 為了嚴(yán)格按照接口進(jìn)行開發(fā)，提高效率，對請求及響應(yīng)格式進(jìn)行規(guī)范化。

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

2、Post請求時(shí)，

可以提交form表單數(shù)據(jù)(application/x-www-form-urlencoded)；

Json數(shù)據(jù)(ContentType=application/json)；

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

3、SpringMVC接收J(rèn)son數(shù)據(jù) 使用@RequestBody注解解析請求的json數(shù)據(jù)。

4、響應(yīng)結(jié)果統(tǒng)一信息為：是否成功、操作代碼、提示信息及自定義數(shù)據(jù)。

5、響應(yīng)結(jié)果統(tǒng)一格式為json。

二、Api定義約束

Api定義使用SpringMVC來完成，由于此接口后期將作為微服務(wù)遠(yuǎn)程調(diào)用使用，在定義接口時(shí)有如下限制：

1、@PathVariable 統(tǒng)一指定參數(shù)名稱，如：@PathVariable("id")

2、@RequestParam統(tǒng)一指定參數(shù)名稱，如： @RequestParam("id")

總結(jié)

以上是生活随笔為你收集整理的java定义接口规范_关于java的接口的一些规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。