发表于: 2017-06-18 23:26:01

2 1254


一、今天完成的事情:

    昨天师兄说的接口问题,回去wiki查了一波接口规范

首先接口分为四部分:方法、uri、请求参数、返回参数

1、方法:新增(post) 修改(put) 删除(delete) 获取(get)

 

2、uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,即:/a/u;后边一般放表名或者能表达这个接口的单词;get方法,如果是查询列表,那么以/search结尾;url参数就不说了。

 

3、请求参数和返回参数,都分为5列:字段、说明、类型、备注、是否必填

字段是类的属性;说明是中文释义;类型是属性类型,只有String、Number、Object、Array四种类型;备注是一些解释,或者可以写一下例子,比如负责json结构的情况,最好写上例子,好让前端能更好理解;是否必填是字段的是否必填。

4、返回参数结构有几种情况: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,1-上架;2-下架。

注意:uri地址里不允许出现大写字母,如果是两个单词拼接,用/分开

  难怪师兄看不下去了O.O

 接口写的时候,讨论对于表结构有变动,在表中修改了一波

 ...逛了一下狗东想买几本书,但没发现有什么好买的,买了一本重构。

 解决了罗师弟的jdk问题

 翻看了一下师兄们构建的几张表,内容没有看,就看看建了几张表和自己的出入是多少

二、遇到的问题:无

三、明天计划的事情:继续写方案

四、收获:分享一个可以不用梯子直接查goole的东西,

https://github.com/racaljk/hosts



返回列表 返回列表
评论

    分享到