接口結果輸出模板類以及接口開發規範

 一.接口開發規範

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

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