项目开发之接口定义规范

在梳理完用户需求后就要去定义前后端的接口，接口定义后前端和后端就可以依据接口去开发功能了。

接口定义约定

如果接口的入参不是简单的一个参数，这个时候就要考虑对入参的封装了，具体封装对象的参数，根据和接口的调用方约定来创建；同样，对于接口的返回值的封装也很重要，规范的接口返回值对于接口的调用方来说，处理起来就方便很多，一般接口的返回值都要有操作是否成功，操作代码，操作信息，这三个最基本的返回参数，其他要返回的信息根据实际场景去定义

接口开发规范

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

1. get请求时，采用key/value格式请求，Springmvc可采用基本类型的变量接收，也可以采用对象接收。
2. post请求时，可以提交form表单数据（application/x-www-form-urlencoded）和json数据（Content-Type=application/json），文件等多部件类型（multiparty/form-data）三种数据格式，Springmvc接收json数据使用@RequestBody注解解析请求json数据
3. 响应结果统一信息为：是否成功，操作代码，提示信息以及自定义数据。
4. 响应结果统一格式为json
5. Api定义使用SpringMVC来完成，由于此接口后面将作为微服务远程调用使用，在定义接口时有如下限制：
   1.@PathVariable统一指定参数名称，如：@PathVariable(“id”)
   2.@RequestParam统一指定参数名称，如：@RequestParam(“id”)