BBS 用户模块接口文档

已于 2023-06-06 02:40:26 修改
阅读量215 收藏 1
点赞数 1
分类专栏： java 文章标签： java servlet springboot
于 2023-05-30 20:57:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_51829728/article/details/130952162
版权

用户模块

返回的数据格式：
status：返回状态码
message：返回的消息
data：返回的数据
示例：
在这里插入图片描述

返回的用户数据：userVo 后端返回的用户数据和前端返回给后端用户数据
userId： 类型：int
username; 类型：string
avatars; 类型：avatar 头像是先上传，然后将返回的头像id传回就行
email; 类型：string
birthday; 类型：date 修改用户信息时，生日要给date类型

注册：

发送验证码
KV说明
请求方式POST
请求URLhttp://localhost:8088/user/sendEmail?email=1586488524@qq.com
请求参数email
返回参数true：发送验证码成功，反之失败

返回示例：
在这里插入图片描述

用户注册
KV说明
请求方式POST
请求URLhttp://localhost:8088/user/register?username=Jack&password=123456&email=1586488524@qq.com&code=804827
请求参数1username用户昵称
请求参数2password密码
请求参数3emailqq邮箱，唯一
请求参数4code验证码
返回参数true：注册成功，反之失败

返回示例：
在这里插入图片描述

登录

用户登录
KV说明
请求方式POST
请求URLhttp://localhost:8088user/login?username=Jack&password=123456
请求参数1username用户昵称
请求参数2password密码
返回数据返回给前端一个token

返回示例：
在这里插入图片描述

用户主页

KV说明
请求方式GET
请求URLhttp://localhost:8088/user/userInfo?userid=16
请求参数1userid用户id
返回数据userVo最上面给了userVo参数

返回示例：
在这里插入图片描述

修改密码

KV说明
请求方式POST
请求URLhttp://localhost:8088/user/password?userEmail=11111111@qq.com&userPassword=123456
请求参数1userEmail用户邮箱
请求参数2userPassword修改后的密码
返回参数true：修改密码成功，反之失败

返回示例：
在这里插入图片描述

修改用户信息

如果上传头像的话，会先调用上传头像的方法（saveOrUpdateAvatar），然后返回一个头像id，然后再将这个头像id作为参数之一传给ChangeUserInfo方法

KV说明
请求方式POST
请求URLhttp://localhost:8088/user/ChangeUserInfo?userid=2&username=李四&avatarid=2&email=1212121@gmail.com
请求参数1userid用户id 类型：int
请求参数2username用户名 类型：string
请求参数3email用户邮箱 类型：string
请求参数4avatarid用户头像id 类型：int
请求参数5birthday用户生日。给个默认值，类型：date
返回参数true：修改用户信息成功，反之失败

返回示例：
在这里插入图片描述

通过用户名查询用户

KV说明
请求方式GET
请求URLhttp://localhost:8088/user/getUserByName?username=test10
参数usernameString类型
返回数据返回单个用户

返回示例：
在这里插入图片描述

查询所有用户

返回所有用户信息，除了密码

KV说明
请求方式GET
请求URLhttp://localhost:8088/user/getAllUser
返回数据返回用户集合

返回示例：
在这里插入图片描述

通过用户id删除用户

KV说明
请求方式POST
请求URLhttp://localhost:8088/user/deleteUser?userId=2
参数userIdint类型，传参用params
返回数据返回用户集合

返回示例：
在这里插入图片描述

上传头像

上传头像，返回一个头像id

KV说明
请求方式POST
请求URLhttp://localhost:8088/user/saveOrUpdateAvatar&avatarid=2&email=1212121@gmail.com
请求参数1avatar头像 类型：file
返回参数返回上传头像的idtrue：上传头像成功，反之失败

返回示例：
在这里插入图片描述

获取所有头像=====可能没有用

KV说明
请求方式POST
请求URLhttp://localhost:8088/user/getAvatar
返回参数头像二进制文件true：上传头像成功，反之失败

返回示例：
在这里插入图片描述

评论模块

新增评论

KV说明
请求方式POST
请求URLhttp://localhost:8088/comment/addComment?invitationid=1&content=文章写得是真的棒&commentidfrom=&userid&posttop&commentid=
请求参数1commentid评论id 类型：int
请求参数2content评论内容 类型：string
请求参数2commentidfrom回复的评论ID 类型：int
请求参数3invitationid帖子ID 类型：int
请求参数4userid发评论用户ID 类型：int
请求参数5posttop置顶。给个默认值，类型：int
返回参数true：评论成功，反之失败

返回示例
在这里插入图片描述

查询评论

KV说明
请求方式get
请求URLhttp://localhost:8088/comment/queryAllComments?invitationId=3
请求参数1invitationId帖子id 类型：int
返回参数返回帖子的根评论和子评论

返回示例
在这里插入图片描述

删除评论

KV说明
请求方式post
请求URLhttp://localhost:8088/comment/DelComment?commentid=11
请求参数1commentid评论id 类型：int
返回参数

返回示例
在这里插入图片描述

聊天模块

进入聊天室

KV说明
请求方式get
请求URLhttp://localhost:8088//{id}/chat{}里是参数(用户id），后面/chat是拼接字符串
请求参数id类型：string 这个id是传userId
返回参数请求成功进入聊天页面

加载用户信息

KV说明
请求方式post
请求URLhttp://localhost:8088//chat/{id}
请求参数id类型：string 这个id也是userId
返回参数请求成功返回用户信息

获取群发消息列表

KV说明
请求方式get
请求URLhttp://localhost:8088//chat/common
请求参数不需要参数
返回参数

每次刷新页面，主动链接WebSocket

KV说明
请求方式post
请求URLws://localhost:8088/chat/{id}
请求参数id类型：string 这个id都是userId
返回参数

获取在线用户列表

KV说明
请求方式get
请求URLhttp://localhost:8088//chat/online/list
请求参数不需要参数
返回参数

获取与指定窗口的消息列表

KV说明
请求方式get
请求URLhttp://localhost:8088//chat/self/{fromId}/{toId}
请求参数1fromId当前登录用户id string类型
请求参数2toId这个是写死了的，当前激活窗口ID：current_window_id: 0,
返回参数

向指定窗口推送消息

KV说明
请求方式get
请求URLhttp://localhost:8088//chat/push/{toId}
请求参数toId这个是写死了的，当前激活窗口ID：current_window_id: 0,
返回参数
yuydot
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
06_04_广告模块与用户模块接口文档
weixin_41596178的博客
03-05 151
2.广告模块 2.1 广告位列表查询 接口地址: http://localhost:8080/ssm-web/PromotionSpace/findAllPromotionSpace 请求方式: GET 接口描述: 获取广告位列表数据 请求示例: http://localhost:8080/ssm-web/PromotionSpace/findAllPromotionSpace 响应参数: 参数名称 参数说明 类型 schema success boolean state int
模块接口文档Demo
ACGkaka的博客
04-08 764
XX模块接口文档1.0 1. XX功能接口 描述： ​ 管理后台修改密码 地址： ​ 192.168.0.111:8080/user/changePwd 请求方式：POST 参数： 参数名 类型 说明 是否必需 token String token信息 是 oldPwd String 旧密码 是 newPwd String 新密码 是 返回值： 字段 类型 说明...
2.【SpringBoot3】用户模块接口开发
qq_44378854的博客
01-21 1576
JWT 全称：JSON Web Token，即用于 web 领域的基于 json 格式的令牌（https://jwt.io/）定义了一种简洁的、自包含的格式，用于通信双方以 json 数据格式安全的传输信息。上面是一个 JWT 令牌字符串，通过两个将字符串分成了三部分，每个字串对应 token 令牌中的一部分。第一部分: Head(头)，是由一段 json 字符串编码得来，该 json 字符串记录两个信息，alg 是加密算法（防篡改），type 是令牌类型。第二部分: Payload(有效载荷)
JMeter做BBS简单登录操作（接口测试）
ypzeng1993的博客
03-22 586
背景： BBS论坛简单登录测试 1）需要获取BBS登录接口参数 登录之前：http://localhost/bbs/forum.php 登录：使用fiddler进行抓包获取登录的url和参数 登录之后：http://localhost/bbs/forum.php 1.新建线程组，修改名称为【BBS简单登录操作】 2.新建3个http请求，分别为登录之前，登录，登录之后 再添加一个【监听...
论坛所用全部接口
weixin_44131498的博客
01-15 585
历时三周，论坛终于完成。 <?php namespace Home\Controller; use Think\Controller; class ArticleController extends Controller { public function getAllTitleList($data = null){ //论坛首页，获取全部文章列表，不需要发送参数，类型...
BBS开发文档
03-10
**BBS开发文档** BBS（Bulletin Board System）是一种在线讨论平台，允许用户发布消息、进行讨论和分享信息。这份文档旨在提供一个关于BBS开发的详细指南，帮助学习者理解BBS系统的构建过程。 ### 1、开发背景 在...
BBS 模块设计说明书
12-24
综上所述，这份文档详细介绍了天博BBS系统的设计思路和技术实现方案，特别是针对前台和后台子系统的具体模块设计以及实体类的设计。这对于开发团队来说是非常宝贵的技术资料，有助于他们更好地理解和实施项目开发...
BBS 系统 设计 文档
03-19
### BBS系统设计文档知识点详解 #### 一、开发平台 在本BBS系统的开发过程中，选择的操作系统为**Slackware12**。Slackware是一款非常稳定的Linux发行版，以其简洁、稳定和安全而著称。对于开发团队而言，使用这样...
bbs需求文档.doc
09-16
本文档涵盖了BBS论坛系统的基本特性和功能，包括但不限于用户注册、登录、发帖、回帖、搜索、用户管理、权限控制等关键模块。同时，文档还将涉及系统的兼容性、可扩展性、安全性等非功能性需求。 0.3 读者对象 本...
如何配置项目访问地址为localhost:8080/
热门推荐
长镜头
03-18 1万+
1、修改conf目录下的server.xml配置 <Host appBase="webapps" autoDeploy="true" name="localhost" unpackWARs="true" xmlNamespaceAware="false" xmlValidation="false"> <!-- path留空代表访问域名
vue生产环境使用localhost请求端口号不是自己设置的？来试试这个
weixin_43663775的博客
11-10 2778
将vue包部署后，请求的端口号自动变成了8888， 设置的请求地址是http://localhost/ 后来用127.0.0.1请求可以了。 有必要深入了解一下localhost和127.0.0.1： localhost不能访问127.0.0.1可以访问的原因及解决方法 有时候我们在调试程序的时候，会出现一些莫名其妙匪夷所思的奇怪问题，localhost不能访问但127.0.0.1可以访问的问题就是其中之一。 我 估计大多数人都不会去想localhost到底与127.0.0.1有什么不同，就比如我，有时候用
Discuz移动接口原理简介
weixin_33778778的博客
12-15 362
2019独角兽企业重金招聘Python工程师标准>>> ...
用户模块-接口说明
weixin_40809507的博客
10-16 2257
用户模块-接口说明 一.用户模块概述 ​ 用户模块主要提供对于是用户使用本产品的基础。用户模块提供以下功能： 用户注册 用户登录 用户激活 用户收获地址新增/修改/删除/设为默认 找回密码 修改密码 二.事件定义 1. 用户激活 ​ 用户在注册的同时会同步发送用户激活的邮件。此激活邮件中存在用户激活的链接，用户通过点击此链接之后，在此页面内进行跳转到激活页面，此页面中有两个按钮，是否激活。用户点击激活之后，通过ajax发送激活请求。进行激活。 2. 用户地址管理 ​ 地址查询功能：在用户访问到地址页
Spring Boot电商项目12：用户模块一：用户模块介绍；（用户模块的内容概述；用户模块的五个接口的接口文档介绍；）
小枯林的博客
02-14 2207
说明： （1）本篇博客主要内容： ●【用户模块】部分将要涉及的内容； ●【用户模块】部分的知识点； ●【用户模块】部分的五个接口的接口文档：【注册】、普通用户【登录】、【更新个性签名】、【退出登录】、【管理员登录】； 目录 1.用户模块部分内容：概述； 2.用户模块知识点； 3.用户模块的5个接口的：接口设计文档； （1）【注册】接口； （2）普通用户的【登录】接口； （3）【更新个性签名】接口； （4）【退出登录】接...
开发多线程程序时，需要注意那些问题
最新发布
OO_SEN的博客
08-23 543
线程安全 竞态条件（Race Condition）：当多个线程同时访问和修改共享资源时，可能会出现竞态条件，导致不确定的行为。需要通过同步机制（如互斥锁、读写锁、原子操作）来保护共享资源。 死锁（Deadlock）：当两个或多个线程相互等待对方释放锁时，程序会陷入死锁状态。避免死锁的一些策略包括：避免嵌套锁、确保加锁顺序一致、使用超时机制等。 活锁（Livelock）：与死锁不同，活锁是指线程不断地尝试获取资源但总是失败，导致无法继续执行。避免频繁重试操作或使用退避算法可以减少活锁的发生。 优先级反转（P
Yolov8：模型部署到安卓端
m0_70694811的博客
08-21 786
下载安装jdk-8u202-windows-x64.exe，这篇文章有百度网盘资源链接，直接下载，并按照这篇文章的JDK步骤进行安装和环境变量配置。C:\Program Files\Java\jdk-1.8\bin和C:\Program Files\Java\jdk-1.8\jre\bin。比如因为我的jdk路径是C:\Program Files\Java\jdk-1.8，所以这两个相对路径就改成。参考这边文章的USB驱动设置和手机端设置。同意协议后，下载相应版本的JDK。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值