接口开发规范（随笔）

1、Api请求及响应规范

在进行开发之前，对接口的请求及响应格式进行规范化，可以有效的提高开发效率。

• get请求，采用key/value格式请求，SpringMVC可采用基本类型的变量接收，也可以采用对象接收；
• post请求，可以提交form表单数据（application/x-www-form-urlencoded）和json数据（Content-Type=application/json），文件等多部件类型（multipart/form-data）三种数据格式，SpringMVC接收json数据，使用@RequestionBody注解解析请求的json数据。
• 响应结果统一信息为：是否成功、操作代码、提示信息及自定义数据。
• 响应结果统一格式为：json。

2、Api定义约束

Api定义使用SpringMVC来完成，考虑到接口在以后可能会作为微服务被远程调用，所以可以做如下限制：

• @PathVariable统一指定参数名称，例如：@PathVariable（"id"）;
• @RequestParam统一指定参数名称，例如：@RequestParam（"id"）。