需求合集 - Strelizia02/AngelinaBot GitHub Wiki

1.注册页面

三个层次:账号-Bot-qq

一个账号可以有多个Bot,一个Bot可以有多个qq(频道bot也视为qq)

接口 header 参数 返回值
获取RSA公钥 公钥
注册接口 name,密码(RSA加密) 个人信息+Token
检查id接口 id bool

注册只填写name和pwd,pwd通过RSA加密后发送给后端,如果注册成功会直接返回token,登录失败会返回错误信息。

2.登录页面

密码登录

接口 header 参数 返回值
获取RSA公钥 公钥
密码登录接口 name,密码(RSA加密) 个人信息+Token

先获得公钥,然后对密码进行RSA加密,把用户名密码传回来,成功后会返回一个token

验证码登录

接口 header 参数 返回值
获取验证码 id 验证码
校验验证码 id, 验证码 个人信息+token

这里需要通过qq和验证码进行登录。你先调用获取验证码接口,获取到六位验证码,展示给用户。让用户用输入的qq号,私聊qq本身,发送【洁哥验证 xxxxxx】。

然后就是定时(5秒调用一次)校验一下,我返回给你验证码是否已通过,然后如果超过一分钟就要重新申请验证码(超过一分钟我会直接删除上一个验证码,不管怎么校验都是无法登录)。

需要有一个显著提示,该qq必须通过AngelinaBot在线。

登录成功后,如果该账户没有name和pwd,那就强制引导用户设置name和pwd。

3.首页

公告

接口 header 参数 返回值
获取公告列表 公告信息

返回一个List公告,List有多长,就轮播多少个。

编辑公告

公告给个编辑按钮(默认隐藏,只有用户是admin才显示)

接口 header 参数 返回值
获取公告列表 公告信息
公告编辑 token 内容 bool

点击编辑以后,跳转到公告详情页面,通过表格的方式展示所有公告比如这样:

公告id 公告内容 公告图片 创建
1 xxxxx 1.jpg 修改 删除
2 yyyyy 2.png 修改 删除

在线Bot图表

接口 header 参数 返回值
Bot图表 Bot统计信息

详细图表

点击图表,跳转到详细页面

接口 header 参数 返回值
Bot信息 token 全部Bot详细信息

树形结构展示Bot的归属信息

调用图表

这里展示每个功能调用了多少次,就是上次那个柱状图

接口 header 参数 返回值
功能信息 功能统计数据

详细图表

这个就通过表格全部展示。。

点击图表,跳转到详细页面

接口 header 参数 返回值
详细功能信息 全部功能统计数据

4.文件页面

接口 header 参数 返回值
文件列表接口 全部可下载文件
文件下载接口 token 全部可下载文件
文件上传接口(待定) token 文件(Form表单) bool
文件删除接口(待定) token 文件(Form表单) bool

这里我没想好是仍在本地还是存到cos,所以接口待定,如果是cos,可能直接调那边的接口就行,不用额外写。

5.个人信息页面

接口 header 参数 返回值
个人信息查询 token 全部个人信息

个人信息修改

接口 header 参数 返回值
账户名修改 token 新名 修改后全部个人信息
密码修改 token 旧密码,新密码 修改后全部个人信息
bot绑定 token qq bool
获取验证码 id 验证码
校验验证码 id, 验证码 个人信息+token

改name需要验证是否冲突(后端验证)

绑定Bot需要通过验证码验证。

改密码需要验证码或者旧密码。

OpenAI分发

接口 header 参数 返回值
分发接口 token id,个数 openai消耗量+余额

这里就由管理员来手动下发token。

6.访问量统计

每次跳转路由有调用接口,记录一次访问,记录访问时间和页面。

接口 header 参数 返回值
记录接口 被访问url
查询接口 访问量的图表

对Bot接口

日常接口(Frame层)

接口 header 参数 返回值
心跳接口 botId,在线信息 boolean
运营数据接口 botId,各种运营数据 boolean

定制接口(Bot层)

接口 header 参数 返回值
openAI接口 botId boolean
下载文件接口 botId,文件名 boolean
查询version接口 botId version三合一
根据version查最新外号 botId,version 外号信息
根据version查最新卡池 botId,version 卡池信息

对Bot广播

接口 header 参数 返回值
更新广播
卡池广播 新卡池信息
外号广播 新外号信息