关于java的接口的一些规范

Posted 2020-11-27 囧囧x鑫

一、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"）