接口结果输出模板类以及接口开发规范

谁践踏了优雅 2022-04-06 12:52 240阅读 0赞

##  一.接口开发规范 ##

### 1.1 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、响应结果统一信息为：是否成功、操作代码、提示信息及自定义数据。

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

### 1.2 Api定义约束 ###

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

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

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

## 二.接口返回模板 ##

### 2.1 demo1 ###

import lombok.Data;
    
    @Data
    public class ResultVO<T> {
    
        /** 错误码. */
        private Integer code;
    
        /** 提示信息. */
        private String msg;
    
        /** 具体内容. */
        private T data;
    }

public class ResultVOUtil {
    
        public static ResultVO success(Object object) {
            ResultVO resultVO = new ResultVO();
            resultVO.setData(object);
            resultVO.setCode(0);
            resultVO.setMsg("成功");
            return resultVO;
        }
    
        public static ResultVO success() {
            return success(null);
        }
    
        public static ResultVO error(Integer code, String msg) {
            ResultVO resultVO = new ResultVO();
            resultVO.setCode(code);
            resultVO.setMsg(msg);
            return resultVO;
        }
    }

### 2.2 demo2 ###

.....................