发表于: 2018-03-13 23:26:10
1 664
今天完成的事情:
1.和前端就微信授权的问题做了讨论,并做了方案的修改。
2.学习了一下接口文档的写法。
接口规范:
首先接口分为四部分:方法、uri、请求参数、返回参数
1、方法:新增(post) 修改(put) 删除(delete) 获取(get)
2、uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,即:/a/u;中间一般放表名或者能表达这个接口的单词;get方法,如果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以/list结尾;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里是具体的参数。
注意:uri地址里不允许出现大写字母,如果是两个单词拼接,用/分开
3.今天才发现之前看的接口文档不对,重新看了一下新的接口文档,并根据接口文档对之前的方案做了些修改。
1.之前的签到日期记录字段的设计不严谨,忽略了年份和月份跨度的问题。修改签到记录字段,并使用update_at字段获取年份和月份信息。由于接口那边请求参数是Integer year,Integer month,所以需要把时间戳格式化,并去除年份和月份,然后做比较。
2.微信端的授权请求交给前端来做,后端只根据code返回OpenID和bind_status即可。
遇到的问题:
1.
时间戳的格式问题,yyyy-MM 得到的日期为 2018-03, 2018-11.但是我需要2018-3这种格式,MM和M怎么选择?
解决方法:
经过测试以后yyyy-M可以获得 2018-3,也可以获得2018-11 ,M可以正常格式。
收获:
1.学习了一种新的获取时间的方式。Calendar(日历)可以方便的获取一些日期。
明天的计划:
1.对照接口文档看看方案还有没有需要更改的地方,然后确定最终 方案。
评论