发表于: 2017-12-15 21:33:35
1 655
今天完成的事情
看了接口的设计规范
接口分为四部分
方法,uri,请求参数,返回参数
方法:
新增(post)
修改(put)
删除(delete)
获取(get)
uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,后边一般放表名或者能表达这个接口的单词;get方法,如果是查询列表,那么以/search结尾
请求参数和返回参数,都分为5列:字段、说明、类型、备注、是否必填
字段是类的属性;说明是中文释义;类型是属性类型,只有String、Number、Object、Array四种类型;备注是一些解释,或者可以写一下例子,比如负责json结构的情况,最好写上例子,好让前端能更好理解
返回参数结构有几种情况:
1、如果只返回接口调用成功还是失败(如新增、删除、修改等),则只有一个结构体:code和message两个参数;
2、如果要返回某些参数,则有两个结构体:1是code/mesage/data,2是data里写返回的参数,data是object类型;3、如果要返回列表,那么有三个结构体,1是code/mesage/data,data是object,里面放置page/size/total/totalPage/list 5个参数,其中list是Arrary类型,list里放object,object里是具体的参数。
5、约定字段,数据库用int,java用integer。比如状态status
明天的技术
表设计
遇到的问题
无
收获
接口规范
评论