发表于： 2017-11-01 23:09:21
1 795
今天完成的任务
1、接口文档规范
看了下午北京的小课堂才知道WIKI上就有接口文档关于返回参数的规范...
返回参数结构有几种情况：
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里是具体的参数。
2、编写前台接口的返回参数
昨天是把前台的接口列出来，今天主要就是根据原型图把接口的返回参数写出来。
用户登录注册
1.发送验证码
请求地址：post /a/code/send
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| mobile | 注册手机号码 | String | 是 | |
| type | 验证码类型 | String | 是 | register：注册验证码 password：找回密码验证码 |
返回参数
字段 | 说明 | 类型 |
|---|---|---|
| code | 状态码 | number |
| message | 消息 | string |
2.用户注册
请求地址：post /a/register
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| mobile | 注册手机号码 | number | 是 | |
| verify | 验证码 | String | 是 | |
| pwd | 密码 | String | 是 |
|
| adviserNo | 理财经理工号 | String | 否 |
返回参数：
字段 | 说明 | 类型 |
|---|---|---|
| code | 状态码 | number |
| message | 消息 | string |
3.用户登录
请求地址：post /a/login
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| mobile | 注册手机号码 | number | 是 | |
| pwd | 密码 | String | 是 |
|
返回参数
字段 | 说明 | 类型 |
|---|---|---|
| code | 状态码 | number |
| message | 消息 | string |
5.忘记密码
请求地址：put /a/password/forget
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| mobile | 注册手机号码 | number | 是 | |
| verify | 验证码 | String | 是 | |
| pwd | 密码 | String | 是 |
|
返回参数
字段 | 说明 | 类型 |
|---|---|---|
| code | 状态码 | number |
| message | 消息 | string |
6、修改密码(旧密码、新密码)
请求地址：put /a/u/pwd
请求参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| oldPwd | 旧密码 | Number | |
| newPwd | 新密码 | Number |
返回参数 :
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 错误代码 | Number | |
| message | 错误信息 | String |
遇到的问题
1、白天不是很懂返回参数怎么写，下午看了小课堂才知道怎么写
2、小课堂的时候还讨论了一个验证码存到session或者数据库两种方案，存到session只适用于验证码数量少的情况。
收获
明天的计划
继续完善前台借口
进度
完善前台接口文档
http://task.ptteng.com/zentao/project-story-405.html
返回列表
评论