北航团队项目_技术规格说明书

1 小程序端设计

1.1 概念分析

给出实体概念以及概念之间的对应关系

本社团管理系统可以抽象出学生、社团、通知、活动和社联5个核心实体概念。社联包含多个社团，一个社团可以包含多个学生，一个学生可以参加多个社团；社团可以发布多个通知；社团可以组织多个活动。

概念类图

图1.1 概念类图

1.2 对象结构图

画出小程序端主要的对象以及组成结构

​ 图1.2 主要对象及组成结构图

1.3 用例实现举例

以加入社团为例

​ 图1.3 时序图

1.4 模块划分

表1.1 模块划分表

模块	功能
用户模块	用户登陆、查询信息、修改信息
活动管理模块	查询单个/所有活动，加入活动
社团管理模块	查询单个/所有社团，加入社团

2.2 部分接口设计

2.2.1 登录接口

请求方式：POST

传入参数

参数	参数类型	说明
username	string	用户名
password	String	六位数密码

返回参数

参数	参数类型	说明
isSuccess	Bool	登录结果
msg	String	返回信息（登录失败原因）

2.2.2 查询所有通知接口

请求方式：GET/POST

传入参数：

参数	参数类型	说明
organizationId	string	社团id

传出参数：

参数	参数类型	说明
title	String	通知标题
content	String	通知内容
aimObject	int	通知对象（学生或社团）
publishTime	Date	通知发布时间

2.2.3 创建通知接口

请求方式：POST

传入参数：

参数	参数类型	说明
organizationId	String	社团id
title	String	通知标题
content	String	通知内容
aimObject	int	通知对象（学生或社团）

传出参数

参数	参数类型	说明
isSuccess	Bool	是否成功发布通知
msg	String	发布失败原因

2.2.4 查询所有通知接口

请求方式：GET/POST

传入参数：

参数	参数类型	说明
organizationId	string	社团id

传出参数：

参数	参数类型	说明
title	String	活动标题
content	String	活动内容
aimObject	int	活动对象（仅限社团或公开）
publishTime	Date	通知发布时间
destination	String	活动地点
maxsize	Int	最大活动人数
phoneNum	String	联系人电话
deadline	Date	报名截止时间
peopleNum	Int	当前报名人数

2.2.5 创建活动

请求方式：POST

传入参数：

参数	参数类型	说明
organizationId	String	社团id
title	String	活动标题
content	String	活动内容
aimObject	int	活动对象（学员或全体学生）
publishTime	Date	通知发布时间
destination	String	活动地点
maxsize	Int	最大活动人数
phoneNum	String	联系人电话
deadline	Date	报名截止时间
peopleNum	Int	当前报名人数

传出参数

参数	参数类型	说明
isSuccess	Bool	是否成功发布活动
msg	String	发布失败原因