Api请求及响应规范

为了严格按照接口进行开发，提高效率，对请求及响应格式进行规范化。

1、get 请求时，采用key/value格式请求，SpringMVC可采用基本类型的变量接收，也可以采用对象接收。

2、Post请求时，可以提交form表单数据（application/x-www-form-urlencoded）和Json数据（Content

Type=application/json），文件等多部件类型（multipart/form-data）三种数据格式，SpringMVC接收Json数据

使用@RequestBody注解解析请求的json数据。

4、响应结果统一信息为：是否成功、操作代码、提示信息及自定义数据。

​ 本项目,统一采用成功信息,相应代码,相应结果组成,并且最终返回结果为QueryResponseResult类型

5、响应结果统一格式为json。

Api定义约束

Api定义使用SpringMVC来完成，由于此接口后期将作为微服务远程调用使用，在定义接口时有如下限制：

1、@PathVariable 统一指定参数名称，如：@PathVariable(“id”)

​ 方法内参数要使用@PathVariable来映射路径上的参数

2、@RequestParam统一指定参数名称，如： @RequestParam（”id”）

public String getDetails(
    @RequestParam(value="param1", required=true) String param1,
        @RequestParam(value="param2", required=false) String param2){
...
}