用户模块
返回的数据格式:
status:返回状态码
message:返回的消息
data:返回的数据
示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/b63d251532ba9a805d7bd4daf2fe67d3.png)
返回的用户数据:userVo 后端返回的用户数据和前端返回给后端用户数据
userId: 类型:int
username; 类型:string
avatars; 类型:avatar 头像是先上传,然后将返回的头像id传回就行
email; 类型:string
birthday; 类型:date 修改用户信息时,生日要给date类型
注册:
发送验证码
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/user/sendEmail?email=1586488524@qq.com | |
请求参数 | email | |
返回参数 | | true:发送验证码成功,反之失败 |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/206b3032bcbbbd547df42e9a35abd49e.png)
用户注册
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/user/register?username=Jack&password=123456&email=1586488524@qq.com&code=804827 | |
请求参数1 | username | 用户昵称 |
请求参数2 | password | 密码 |
请求参数3 | email | qq邮箱,唯一 |
请求参数4 | code | 验证码 |
返回参数 | | true:注册成功,反之失败 |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/6e84cf0db701313e142585f3465d8b83.png)
登录
用户登录
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088user/login?username=Jack&password=123456 | |
请求参数1 | username | 用户昵称 |
请求参数2 | password | 密码 |
返回数据 | | 返回给前端一个token |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/684bdbf51d9cc2285a023e9383335354.png)
用户主页
K | V | 说明 |
---|
请求方式 | GET | |
请求URL | http://localhost:8088/user/userInfo?userid=16 | |
请求参数1 | userid | 用户id |
返回数据 | userVo | 最上面给了userVo参数 |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/30469b40f71b584a32bd6b5978698be2.png)
修改密码
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/user/password?userEmail=11111111@qq.com&userPassword=123456 | |
请求参数1 | userEmail | 用户邮箱 |
请求参数2 | userPassword | 修改后的密码 |
返回参数 | | true:修改密码成功,反之失败 |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/ca37c0affd92eb5d4f7520a87c19962d.png)
修改用户信息
如果上传头像的话,会先调用上传头像的方法(saveOrUpdateAvatar),然后返回一个头像id,然后再将这个头像id作为参数之一传给ChangeUserInfo方法
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/user/ChangeUserInfo?userid=2&username=李四&avatarid=2&email=1212121@gmail.com | |
请求参数1 | userid | 用户id 类型:int |
请求参数2 | username | 用户名 类型:string |
请求参数3 | email | 用户邮箱 类型:string |
请求参数4 | avatarid | 用户头像id 类型:int |
请求参数5 | birthday | 用户生日。给个默认值,类型:date |
返回参数 | | true:修改用户信息成功,反之失败 |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/205536d4240b863958ead5e72a6b71e0.png)
通过用户名查询用户
K | V | 说明 |
---|
请求方式 | GET | |
请求URL | http://localhost:8088/user/getUserByName?username=test10 | |
参数 | username | String类型 |
返回数据 | 返回单个用户 | |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/4d571603b610c81d3358884b59120d48.png)
查询所有用户
返回所有用户信息,除了密码
K | V | 说明 |
---|
请求方式 | GET | |
请求URL | http://localhost:8088/user/getAllUser | |
返回数据 | 返回用户集合 | |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/0abf3d26978cfc5b31535625d43a44a6.png)
通过用户id删除用户
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/user/deleteUser?userId=2 | |
参数 | userId | int类型,传参用params |
返回数据 | 返回用户集合 | |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/93ca9735b322280ecf5b7f8a940f337c.png)
上传头像
上传头像,返回一个头像id
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/user/saveOrUpdateAvatar&avatarid=2&email=1212121@gmail.com | |
请求参数1 | avatar | 头像 类型:file |
返回参数 | 返回上传头像的id | true:上传头像成功,反之失败 |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/fb03c0fc46a03ecb3a0524d2a898ec11.png)
获取所有头像=====可能没有用
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/user/getAvatar | |
返回参数 | 头像二进制文件 | true:上传头像成功,反之失败 |
返回示例:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/b34cf4791b6127c571730f89258b0d77.png)
评论模块
新增评论
K | V | 说明 |
---|
请求方式 | POST | |
请求URL | http://localhost:8088/comment/addComment?invitationid=1&content=文章写得是真的棒&commentidfrom=&userid&posttop&commentid= | |
请求参数1 | commentid | 评论id 类型:int |
请求参数2 | content | 评论内容 类型:string |
请求参数2 | commentidfrom | 回复的评论ID 类型:int |
请求参数3 | invitationid | 帖子ID 类型:int |
请求参数4 | userid | 发评论用户ID 类型:int |
请求参数5 | posttop | 置顶。给个默认值,类型:int |
返回参数 | | true:评论成功,反之失败 |
返回示例
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/cde7c9f3a7fca705424b316e3483739b.png)
查询评论
K | V | 说明 |
---|
请求方式 | get | |
请求URL | http://localhost:8088/comment/queryAllComments?invitationId=3 | |
请求参数1 | invitationId | 帖子id 类型:int |
返回参数 | | 返回帖子的根评论和子评论 |
返回示例
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/bb8b1d9744395c907247254e3b80c5ef.png)
删除评论
K | V | 说明 |
---|
请求方式 | post | |
请求URL | http://localhost:8088/comment/DelComment?commentid=11 | |
请求参数1 | commentid | 评论id 类型:int |
返回参数 | | |
返回示例
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/daa31a90c40db0b2ae7d2ce8262811bf.png)
聊天模块
进入聊天室
K | V | 说明 |
---|
请求方式 | get | |
请求URL | http://localhost:8088//{id}/chat | {}里是参数(用户id),后面/chat是拼接字符串 |
请求参数 | id | 类型:string 这个id是传userId |
返回参数 | | 请求成功进入聊天页面 |
加载用户信息
K | V | 说明 |
---|
请求方式 | post | |
请求URL | http://localhost:8088//chat/{id} | |
请求参数 | id | 类型:string 这个id也是userId |
返回参数 | | 请求成功返回用户信息 |
获取群发消息列表
K | V | 说明 |
---|
请求方式 | get | |
请求URL | http://localhost:8088//chat/common | |
请求参数 | 不需要参数 | |
返回参数 | | |
每次刷新页面,主动链接WebSocket
K | V | 说明 |
---|
请求方式 | post | |
请求URL | ws://localhost:8088/chat/{id} | |
请求参数 | id | 类型:string 这个id都是userId |
返回参数 | | |
获取在线用户列表
K | V | 说明 |
---|
请求方式 | get | |
请求URL | http://localhost:8088//chat/online/list | |
请求参数 | 不需要参数 | |
返回参数 | | |
获取与指定窗口的消息列表
K | V | 说明 |
---|
请求方式 | get | |
请求URL | http://localhost:8088//chat/self/{fromId}/{toId} | |
请求参数1 | fromId | 当前登录用户id string类型 |
请求参数2 | toId | 这个是写死了的,当前激活窗口ID:current_window_id: 0, |
返回参数 | | |
向指定窗口推送消息
K | V | 说明 |
---|
请求方式 | get | |
请求URL | http://localhost:8088//chat/push/{toId} | |
请求参数 | toId | 这个是写死了的,当前激活窗口ID:current_window_id: 0, |
返回参数 | | |