API服务器接口需求
Closed this issue · 4 comments
- GET 得到部门树
- 输入:
- 输出:后端返回的列表
- GET 得到某个社团的用户
- 输入:社团ID
- 输出:用户列表
- GET 得到某个部门的信息
- 输入:社团ID,部门ID
- 输出:部门信息
- POST 创建某个部门
- 输入:社团ID
- 输出:部门信息
- DELETE 删除某个部门
- 输入:社团ID
- 输出:成功与否
- PUT 编辑某个部门信息
- 输入:社团ID
- 输出:编辑后的部门信息
- GET 得到某个部门的用户
- 输入:社团ID
- 输出:用户列表
- DELETE 将用户从某个部门中删除
- 输入:社团ID
- 输出:成功与否
- POST 为某个部门添加成员
- 输入:社团ID
- 输出:成功与否
- POST 向某个社团添加成员
- 输入:社团ID
- 输出:成功与否
- DELETE 将某个成员从社团中删除
- 输入:社团ID
- 输出:成功与否
-
GET 得到社团列表
- 输入:搜索关键字,标签,社团状态
- 输出:符合条件的社团列表
-
GET 得到某个社团的信息
- 输入:社团Id
- 输出:对应的社团信息
-
POST 创建某个社团(系统管理员)
- 输入:社团名称,社团描述,社团标签,社团Logo
- 输出:社团信息
-
DELETE 删除某个社团
- 输入:社团Id
- 输出:是否成功
-
PUT 编辑某个社团的信息
- 输入:社团Id,社团名称,社团描述,社团标签,社团Logo
- 输出:编辑后的社团信息
-
POST 创建"创建社团"申请
- 输入:社团信息(社团名称,社团描述,社团标签,社团Logo),创建者Id,材料列表
- 输出:申请信息
-
POST 创建"解除社团封禁"申请
- 输入:解除封禁信息(社团Id,解禁理由),创建者Id
- 输出:申请信息
-
DELETE 取消申请
- 输入:申请Id
- 输出:是否成功
-
PATCH 接受申请
- 输入:申请Id
- 输出:是否成功
-
PATCH 拒绝申请
- 输入:申请Id
- 输出:是否成功
-
PATCH 改变社团状态(系统管理员,有封禁社团,解禁社团两种操作)
- 输入:社团ID,操作类型(封禁,解禁),操作者Id,操作描述
- 输出:是否成功
Activity Manager
-
POST 创建活动
-
输入
Parameter Description associationIds
int[]社团IDs title
string标题 content
string内容(简介) signupTime
NewDateTime报名时间范围 time
NewDateTime活动时间范围 ifReview
bool报名是否需要审核 ifOnlyMem
bool是否仅社团成员参加 numberOfParticipants
int最大参加人数 materialTemplateIds
int[]材料模板 tags
string[]标签 image
String活动图片 -
输出
- 活动
-
-
POST 修改活动
- 输入
Parameter Description associationIds
int[]社团IDs title
string标题 content
string内容(简介) signupTime
NewDateTime报名时间范围 time
NewDateTime活动时间范围 ifReview
bool报名是否需要审核 ifOnlyMem
bool是否仅社团成员参加 numberOfParticipants
int最大参加人数 materialTemplateIds
int[]材料模板 tags
string[]标签 image
String活动图片 - 输出
- 活动
-
POST 发布活动
- 输入
- 活动ID
- 动作类型 "publish"
- 输出
- 无/(true, false)
- 输入
-
POST 取消发布活动
- 输入
- 活动ID
- 动作类型 "withdraw"
- 输出
- 无/(true, false)
- 输入
-
POST 筛选活动(分页)
-
输入
-
Query Parameters
Parameter Description default Value pagesize
每页数量 8 pagenum
页号 0 sortby
排序方式 0 -
Body Parameters
-
-
输出
- 活动列表
-
-
GET 查询单个活动(详情)
- 输入
- 活动ID
- 输出
- 活动
- 输入
-
POST 通过审核
- 输入
- 活动ID
- 用户ID
- 操作 (string: "accept")
- 输出
- 无/(true/false)
- 输入
-
POST 不通过审核
- 输入
- 活动ID
- 用户ID
- 操作 (string: "refused")
- 输出
- 无/(true/false)
- 输入
-
POST 筛选标签列表(根据keyword,分页)
- 输入
- keyword
- 输出
- tag列表
- 输入
-
POST 存储标签
- 输入- 待标签列表
- 输出 - 无/(true/false)
- 待标签列表
-
POST 查询参加者(分页)
- 输入- pagesize
- pagenum
- 用户类型(participant是1,realParticipant是2, 这里是1)
- 输出 - 参加者列表
-
POST 查询实际参加者(分页)
- 输入- pagesize
- pagenum
- 用户类型(participant是1,realParticipant是2, 这里是2)
- 输出 - 参加者列表
系统管理员后台页面
需要 (scope, permission)
权限管理页面
-
创建权限 (sys, write_permission)
- 输入:
- 权限名
- 分类
- 描述
- 输入:
-
移除权限 (sys, write_permission)
- 输入:
- 权限名
- 输入:
-
修改权限 (sys, write_permission)
- 输入:
- 权限名
- 分类
- 描述
- 输入:
-
获取所有权限 (sys, read_permission)
角色管理页面
-
创建角色 (sys, write_role)
- 输入:
- 角色名
- 分类
- 描述
- 输入:
-
编辑角色 (sys, write_role)
- 输入:
- 角色名
- 分类
- 描述
- 输入:
-
移除角色 (sys, write_role)
- 输入:
- 角色名
- 输入:
-
获取角色 (sys, read_role)
-
输入:
- 分类
-
输出:
- 角色列表
-
-
给角色添加权限 (sys, write_role)
- 输入:
- 角色名
- 权限名列表
- 输入:
-
移除角色权限 (sys, write_role)
- 输入:
- 角色名
- 权限名列表
- 输入:
用户管理页面
-
创建用户(暂时只能通过注册创建用户)- 输入:
- 各种用户信息
- 输入:
-
编辑用户(暂时只能由用户自己修改信息)- 输入:
- 用户id
- 各种用户信息
- 输入:
-
通过scope和role查找用户 (sys, read_user)
- 输入:
- scope
- role (可以为空)
- 页码
- 每页数量
- 输出
- 用户列表
- 实际页码
- 实际每页数量
- 用户总数
- 输入:
-
给用户添加角色 (sys, write_user_role)
- 输入:
- 用户id
- scope
- 角色名列表
- 输入:
-
删除用户角色 (sys, write_user_role)
- 输入:
- 用户id
- scope
- 角色名列表
- 输入:
-
获取用户所有角色 (sys, read_user_role)
-
输入:
- 用户id
- scope
-
输出:
- 角色列表
-