-
Notifications
You must be signed in to change notification settings - Fork 0
用户模块接口规范
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| userName | int | 否 | 手机号(作为登录名) |
| code | int | 否 | 验证码 |
| password | int | 否 | 密码 |
- 生产环境:/user/register
##返回结果
{
"re":1,
"msg":"success",
"data":{
"token":"e4a6f67450af440aa6f67450af740aea"
}
}
| 参数名称 | 参数类型| 备注说明| | -------------|:-------------:|:-------------: |:-------------:| -----:| | re | int| 状态码，[1:成功,-1:失败]| | msg | string| 操作提示语| | token| string| 授权token|
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| userName | string | 否 | 手机号(作为登录名) |
| password | string | 否 | 密码 |
- 生产环境:/user/login
##返回结果
{
"re":1,
"msg":"success",
"data":{
"token":"e4a6f67450af440aa6f67450af740aea"
}
}
| 参数名称 | 参数类型| 备注说明| | -------------|:-------------:|:-------------: |:-------------:| -----:| | re | int| 状态码，[1:成功,-1:失败]| | msg | string| 操作提示语| | token| string| 授权token|
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| userId | string | 否 | 用户id |
- 生产环境:/v1/user/logout
##返回结果
{
"re":1,
"msg":"success",
"data":{}
}
无
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| userId | string | 否 | 用户id |
| nickName | string | 否 | 用户昵称 |
| sex | string | 否 | 性别 |
| img | string | 否 | 用户头像 |
- 生产环境:/v1/user/modifyUserInfo
##返回结果
{
"re":1,
"msg":"success",
"data":{}
}
无
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| token | string | 否 | 授权token |
- 生产环境:v1/user/home
##返回结果
{
"re":1,
"msg":"success",
"data":{
"userId":"123",
"username":"tangchao",
"nickName":"牛大厨",
"rank":"5",
"rankName":"的客新人",
"level":"10",
"levelName":"的客新人",
"img":"http://image.com",
"sex":"男"
}
}
| 参数名称 | 参数类型| 备注说明| | -------------|:-------------:|:-------------: |:-------------:| -----:| | re | int| 状态码，[1:成功,-1:失败]| | msg | string| 操作提示语| |userId |string | 用户ID| |username|string | 用户名| |nickName |string | 昵称| |rank |string | 等级ID| |rankName |string | 等级名称| |level | string|会员级别 | |levelName | string|会员级别名称 | |img | string| 用户头像| |sex| string| 用户性别|
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| userId | string | 否 | 当前登录用户ID |
- 生产环境:v1/user/myFollow
##返回结果
{
"re":1,
"msg":"success",
"data":{
[
{
"userId":"123",
"username":"tangchao",
"nickName":"牛大厨",
"rank":"5",
"rankName":"银牌厨夫",
"level":"10",
"levelName":"的客新人",
"img":"http://image.com"
"sex":"男",
},
{
"userId":"234",
"username":"yuanyuan",
"nickName":"媛媛baby",
"rank":"4",
"rankName":"金牌厨娘",
"level":"22",
"levelName":"的客大神",
"img":"http://image.com"
"sex":"男",
},
]
}
}
| 参数名称 | 参数类型| 备注说明|
| -------------|:-------------:|:-------------: |:-------------:| -----:|
| re | int| 状态码，[1:成功,-1:失败]|
| msg | string| 操作提示语|
|userId |string | 用户ID|
|username|string | 用户名|
|nickName |string | 昵称|
|rank |string | 等级ID|
|rankName |string | 等级名称|
|level | string|会员级别 |
|levelName | string|会员级别名称 |
|img | string| 用户头像|
|sex| string| 用户性别|
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| userId | string | 否 | 当前登录用户ID |
- 生产环境:v1/user/collection
##返回结果
{
"re":1,
"msg":"success",
"data":{
[
{
"menuId":"123",
"title":"炖猪脚",
"tip":"请用小火慢炖",
"mainImage":"http://image.com",
"viewCount":"5000",
"userCollectCount":"200",
"createTime":"2016-09-11 00:06:32",
},
{
"menuId":"222",
"title":"辣椒炒肉",
"tip":"请用大火爆炒",
"mainImage":"http://image.com",
"viewCount":"4000",
"userCollectCount":"200",
"createTime":"2016-09-11 00:06:32",
},
]
}
}
| 参数名称 | 参数类型| 备注说明| | -------------|:-------------:|:-------------: |:-------------:| -----:| | re | int| 状态码，[1:成功,-1:失败]| | msg | string| 操作提示语| |menuId|string | 菜谱ID| |title|string | 菜谱标题| |tip|string | 小贴士| |mainImage|string | 菜谱主图(用于列表展示)| |viewCount|string | 浏览量| |userCollectCount| string|用户收藏数 | |createTime| string|创建时间 |
| 参数名称 | 参数类型 | 可否为空 | 备注说明 |
|---|---|---|---|
| token | string | 否 | 当前登录用户授权码 |
| pageNumber | int | 可空 | 一页显示的数据量 |
| pageSize | int | 可空 | 页数 |
| dateTime | string | 否 | 时间戳 |
- 生产环境:v1/user/publish
##返回结果
{
"re": 1,
"msg": "success",
"data": {
"img": "http://123.jpg",
"nickname": "yuanyuanbaby",
"rankName": "金牌厨娘",
"fansCount": "201",
"userMenuCount": "15",
"userArticalCount": "35",
"menus": [
{
"menuId": "123",
"title": "西班牙烤肉",
"mainImage": "http://456.jpg",
"viewCount": "123",
"userCollectCount": "123"
},
{
"menuId": "124",
"title": "意味龙虾",
"mainImage": "http://456.jpg",
"viewCount": "123",
"userCollectCount": "123"
},
{
"menuId": "125",
"title": "章鱼瘦肉扒饭",
"mainImage": "http://456.jpg",
"viewCount": "123",
"userCollectCount": "123"
}
],
"articals": [
{
"aticleId": "225",
"title": "生命不仅于苟且",
"mainImage": "http://456.jpg;http://abc.jpg;http://qzr.jpg",
"createTime": "2016-05-16 00:00:00",
"followCount": "123",
"commentCount": "123",
"likeCount": "123"
},
{
"aticleId": "226",
"title": "还有诗和远方",
"mainImage": "http://456.jpg;http://abc.jpg;http://qzr.jpg",
"createTime": "2016-05-16 00:00:00",
"followCount": "123",
"commentCount": "123",
"likeCount": "123"
},
{
"aticleId": "228",
"title": "小明的一生",
"mainImage": "http://456.jpg;http://abc.jpg;http://qzr.jpg",
"createTime": "2016-05-16 00:00:00",
"followCount": "123",
"commentCount": "123",
"likeCount": "123"
}
]
}
}
| 参数名称 | 参数类型| 备注说明|
| -------------|:-------------:|:-------------: |:-------------:| -----:|
| re | int| 状态码，[1:成功,-1:失败]|
| msg | string| 操作提示语|
|img |string | 用户头像|
|nickName |string | 昵称|
|rankName |string | 等级名称|
|fansCount | int|粉丝数 |
|userMenuCount | int|用户菜单数量 |
|userArticalCount| int| 用户圈子数量|
|menus| list| 菜单信息（以list表示）|
|menuId | int| 菜谱ID|
|title | string| 菜谱名称|
|mainImage| string| 标题图片|
|viewCount | int| 菜谱浏览量|
|userCollectCount| int| 菜谱收藏量|
|articals| list| 帖子信息（以list表示）|
|aticleId | int|帖子ID|
|title | string| 帖子名称|
|mainImage| string| 帖子标题图片（多个图片中间以逗号分隔）|
|createTime | string| 创建时间|
|followCount | int| 分享数|
|commentCount | int|评论数|
|likeCount| int| 点赞数|