“# “学成项目

CMS 接口开发

---

1. 接口开发规范

1.1 API请求及相应规范

为了严格按照接口开发，提高效率，对请求及响应格式进行规范化。
1、 get请求时，采用key/value格式请求，SpringMVC可以接收基本类型的变量也可以接收引用数据类型。
2、 Post请求时，可以提交form表单数据（application/x-www-form-urlencoded）和Json数据（ContentType=application/json），文件等多部件类型（multipart/form-data）三种数据格式，SpringMVC接收Json数据，使用@RequestBody注解解析请求的json数据。
3、响应结果统一信息为：是否成功、操作代码、提示信息及自定义数据。5、响应结果统一格式为json。

1.2 Api定义约束

Api定义使用SpringMVC来完成，由于接口后期将作为微服务远程调用使用，接口有如下限制
1、@PathVariable 统一指定参数名称，如：@PathVariable("id") 2、@RequestParam统一指定参数名称，如：@RequestParam（"id")