前后端API简述 Overview of API
1. 用户登录与登录状态验证接口
currentUser
- 此API用于用户登录与登录状态验证
- 交互逻辑:
- 通过发送GET请求到/api/currentUser
- 返回的数据结构包括当前用户的信息
- 登录状态验证currentUser会得到当前用户的所有信息,故而此流程也是其他所有功能实现的前提。
- 流程图如下所示
2. 登录接口
login
- 此API用于用户的登录操作。
- 交互逻辑:
- 通过发送POST请求到/api/login/account,并附带登录参数(例如用户名和密码)
- 响应的数据结构包括登录结果,如果响应中包含token,则将其保存到本地存储。
- 流程图如下所示
3.重置密码接口
resetPassword
- 此流程用于用户重设密码
- 交互逻辑:
- 通过发送POST请求到/api/reset_password,并附带重置密码所需的信息
- 若所有输入数据正确,则使用用户输入的新密码更新数据库中的密码。
- 流程图如下所示
4. 注册接口
register
- 此API用于用户的登录操作。
- 交互逻辑:
- 发送POST请求到/api/register,并附带注册参数(例如用户名、密码等)
- 响应的数据结构包括注册是否成功的信息。
- 流程图如下所示
5. 修改个人信息接口
updateUserInfo
- 此API用于用户自行修改个人信息。
- 交互逻辑:
- 发送PUT请求到/api/update_user,并附带需要修改的信息和相关参数(例如当前用户id)
- 响应的数据结构包括修改是否成功的信息。
- 流程图如下所示
6. 获取规则列表接口
rule
- 此API用于获取规则列表,用于数据的分页展示。
- 交互逻辑:
- 通过发送GET请求到/api/rule,并附带分页参数(例如当前页码、页面容量等),可能还会附带一些可选的请求选项。
- 返回的数据结构应包括规则列表的信息。
- 流程图如下所示
7. 更新规则接口
updateRule
- 此API用于更新现有的规则,用于数据的分页展示。
- 交互逻辑:
- 通过发送PUT请求到/api/rule,并附带分页参数(例如当前页码、页面容量等),可能还会附带一些可选的请求选项。
- 返回的数据结构应包括规则列表的信息。
- 流程图如下所示
8. 新建规则接口
addRule
- 此API用于更新现有的规则,用于数据的分页展示。
- 交互逻辑:
- 通过发送POST请求到/api/rule,可能还会附带一些可选的请求选项。
- 返回的数据结构应包括新建规则的信息。
- 流程图如下所示
9. 删除规则接口
removeRule
- 此API用于删除指定的规则。
- 交互逻辑:
- 通过发送DELETE请求到/api/rule,可能还会附带一些可选的请求选项。
- 返回的数据结构应包括与删除规则操作有关的信息。
- 流程图如下所示