前台 用户模块 - d4smart/Traveller GitHub Wiki
1. 注册
/user/register post
request
username,password,gender,phone,avatar,signature,captcha
必需：username,password,captcha
说明：gender必须为男或女
response
fail
{
"code": 1,
"msg": "验证码错误/用户信息不完整/用户性别填写错误/用户名已存在/手机号已存在/注册失败"
}
success
{
"code": 0,
"msg": "注册成功"
}
2. 登陆
/user/login post
request
username,password,captcha
必需：username,password,captcha
response
fail
{
"code": 1,
"msg": "验证码错误/用户名或密码不能为空/用户名与密码不匹配/暂时不可以登陆，如有疑问，请联系后台管理员"
}
success
{
"code": 0,
"msg": "登陆成功",
"data":{
"id": 1,
"username": "d4smart",
"gender": "男",
"phone": "15171444706",
"avatar": "/image/2018/03/1522401513524.png",
"signature": "一江春水向东流",
"canLogin": true,
"canPublish": true,
"isAdmin": true,
"createTime": "2018-03-30 11:18:19",
"updateTime": "2018-04-02 19:17:25"
}
}
3. 获取自己的信息
/user/info get
request
无参数
response
success
{
"code": 0,
"data":{
"id": 1,
"username": "d4smart",
"gender": "男",
"phone": "15171444706",
"avatar": "/image/2018/03/1522401513524.png",
"signature": "一江春水向东流",
"canLogin": true,
"canPublish": true,
"isAdmin": true,
"createTime": "2018-03-30 11:18:19",
"updateTime": "2018-04-02 19:17:25"
}
}
4. 更新用户信息
/user/update post
request
username,password,gender,phone,avatar,signature
必需：无
说明：gender必须为男或女
response
fail
{
"code": 1,
"msg": "用户性别填写错误/用户名已存在/手机号已存在/更新用户信息失败"
}
success
{
"code": 0,
"msg": "更新用户信息成功",
"data":{
"id": 1,
"username": "d4smart",
"gender": "男",
"phone": "15171444706",
"avatar": "/image/2018/03/1522401513524.png",
"signature": "一江春水向东流",
"canLogin": true,
"canPublish": true,
"isAdmin": true,
"createTime": "2018-03-30 11:18:19",
"updateTime": "2018-04-02 19:52:39"
}
}
5. 检查 用户名/手机号 是否合法
/user/checkValid get
request
type(username/phone),value(对应的值)
必需：type,value
response
fail
{
"code": 1,
"msg": "参数错误/用户名已存在/手机号已存在"
}
success
{
"code": 0,
"msg": "校验成功"
}
6. 登出
/user/logout post
request
无参数
response
success
{
"code": 0,
"msg": "退出登陆成功"
}
7. 关注用户
/user/follow post
request
id
必需：id
response
fail
{
"code": 1,
"msg": "自己不能关注自己/要关注的用户不存在/关注用户失败/您已经关注过这个用户"
}
success
{
"code": 0,
"msg": "关注用户成功"
}
8. 取消关注用户
/user/unfollow post
request
id
必需：id
response
fail
{
"code": 1,
"msg": "自己不能取消关注自己/要取消关注的用户不存在/取消关注用户失败"
}
success
{
"code": 0,
"msg": "取消关注用户成功"
}
9. 是否关注了用户
/user/isFollowing get
request
id
必需：id
response
fail
{
"code": 1,
"msg": "参数错误/没有关注这个用户"
}
success
{
"code": 0,
"msg": "关注了这个用户"
}
10. 粉丝
/user/follower get
request
pageNum,pageSize
必需：无
response
success
{
"code": 0,
"data": {
"list": [
],
"pageNum": 1,
"pageSize": 10,
"totalPage": 0,
"totalRow": 0
}
}
11. 关注的人
/user/following get
request
pageNum,pageSize
必需：无
response
success
{
"code": 0,
"data": {
"list": [
{
"id": 2,
"username": "易水人去",
"gender": "女",
"phone": "15896209327",
"avatar": "",
"signature": "",
"canLogin": true,
"canPublish": true,
"isAdmin": false,
"createTime": "2018-03-30 14:26:13",
"updateTime": "2018-03-30 14:26:13"
},
{
"id": 3,
"username": "d4smarter",
"gender": "男",
"phone": "17553421379",
"avatar": "/image/2018/04/1522634396537.jpg",
"signature": "一蓑烟雨任平生",
"canLogin": true,
"canPublish": true,
"isAdmin": false,
"createTime": "2018-04-02 19:39:27",
"updateTime": "2018-04-02 19:39:27"
},
{
"id": 5,
"username": "iomger",
"gender": "男",
"phone": "17551321379",
"avatar": "1.jpg",
"signature": "一蓑烟雨任平生",
"canLogin": true,
"canPublish": true,
"isAdmin": false,
"createTime": "2018-04-09 16:09:41",
"updateTime": "2018-04-09 16:09:41"
},
{
"id": 6,
"username": "yat140",
"gender": "女",
"phone": "13297968882",
"avatar": "",
"signature": "",
"canLogin": true,
"canPublish": true,
"isAdmin": false,
"createTime": "2018-04-10 15:48:48",
"updateTime": "2018-04-10 15:48:48"
},
{
"id": 13,
"username": "mageluer",
"gender": "男",
"phone": "13611337789",
"avatar": "666.jpg",
"signature": "一蓑烟雨任平生",
"canLogin": true,
"canPublish": true,
"isAdmin": false,
"createTime": "2018-04-16 16:55:53",
"updateTime": "2018-04-16 16:55:53"
}
],
"pageNum": 1,
"pageSize": 10,
"totalPage": 1,
"totalRow": 5
}
}
12. 用户动态
/user/dynamics get
request
pageNum,pageSize
必需：无
说明：根据用户的关注生成的攻略动态，类似于QQ中的好友动态功能
response
success
{
"code": 0,
"data": {
"list": [
{
"id": 15487,
"title": "武汉一日游",
"authorId": 6,
"author": {
"username": "yat140",
"avatar": "/image/2018/05/1525232310539.jpg"
},
"places": "武汉",
"thumbnail": "/image/2018/04/1524799754504.jpg",
"views": 1,
"likes": 0,
"comments": 0,
"createTime": "2018-04-27 11:29:14",
"updateTime": "2018-05-07 17:27:27"
},
{
"id": 15486,
"title": "武汉一日游",
"authorId": 6,
"author": {
"username": "yat140",
"avatar": "/image/2018/05/1525232310539.jpg"
},
"places": "武汉",
"thumbnail": "",
"views": 0,
"likes": 0,
"comments": 0,
"createTime": "2018-04-27 11:28:11",
"updateTime": "2018-04-27 11:28:11"
},
{
"id": 15485,
"title": "去旅游",
"authorId": 6,
"author": {
"username": "yat140",
"avatar": "/image/2018/05/1525232310539.jpg"
},
"places": "香山公园",
"thumbnail": "",
"views": 0,
"likes": 0,
"comments": 0,
"createTime": "2018-04-27 11:22:42",
"updateTime": "2018-04-27 11:22:42"
}
],
"pageNum": 1,
"pageSize": 3,
"totalPage": 6,
"totalRow": 16
}
}
13. 获取用户信息
/user/get get
request
id（用户的id）
必需：id
response
fail
{
"code": 1,
"msg": "参数错误/用户不存在"
}
success
{
"code": 0,
"data": {
"follower": 1,
"following": 4,
"collection": 3,
"user": {
"id": 1,
"username": "d4smart",
"gender": "男",
"phone": "17551321379",
"avatar": "/image/2018/04/1524022147663.jpg",
"signature": "恰似飞鸿踏雪泥",
"createTime": "2018-03-30 11:18:19",
"updateTime": "2018-05-07 10:24:05"
}
}
}