接口规范

接口规范

接口主要分为四个部分：方法、uri、请求参数、返回参数。

• uri：uri地址里不能出现大写字母，如果是两个单词拼接，用 / 分开。它以 /a 开头。对于需要登录才能调用的接口，后面 /a 后面要加上 /u ，也就是 /a/u。中间放表名，或是能表示这个接口的表示词。如果是后台的查询列表，就通过 /search 结尾；如果是前台的查询列表，就通过 /list 结尾。比如请求地址是：/a/student/list
• 请求参数和返回参数，都分为5列，字段、说明、类型、备注、是否必填，其中备注可以方便我们做一些解释，让前端能更好的理解。
• 返回参数有几种情况：第一种是只返回接口调用成功或失败，比如新增、删除和修改，那么就只有一个含有 code 和 message 两个参数的结构体。第二种是要返回某些参数，就有两个结构体，1个是 code/message/data，1个是 data 里写的返回参数，data 是 object 类型。第三种是返回列表，就有三个结构体，也就是在第二种的基础上，data里还有一个list，list 是 Array 类型，里面放 object，object 里是具体的参数。