您的位置:首页 > 其它

项目技术规格说明书

2017-10-26 20:04 99 查看

项目技术规格说明书

0. 数据库ER图



其中,灰色部分为Alpha阶段暂不考虑内容,深红色属性为主码。

1. GET

URL界面
/首页
/course课程查找界面
/course/[course_id]课程界面
/course/[course_id]/resource课程资源界面
/contact联系我们
/user/[username]/home个人中心首页

2. POST

2.1 课程选择相关

2.1.1 获取某学院课程列表

url: /course/college_course

前端提供:

名称类型备注
college_idint院系号
后端提供:

名称类型备注
course_id_list[course_id0, course_id1, course_id2, ...] course_id:int课程编号列表

2.1.2 通过某课程类别课程列表

url: /course/classification_course

前端提供:

名称类型备注
course_kindint课程类别号
后端提供:

名称类型备注
course_id_list[course_id0, course_id1, course_id2, ...] course_id:int课程编号列表

2.2 课程相关

2.2.1 查询课程详细信息

url: /course/information

前端提供:

名称类型备注
course_idint课程编号
后端提供:

名称类型备注
namestr课程名称
teacherstr授课教师名称
collegestr开课院系
hoursint学时
introstr课程简介
picturestr课程图片的url,前端加载时直接加载图片网址
resources_numint资源数量
resources_id_listlist [resource_id0, resource_id1, resource_id2, ...] resource_id:int资源文件编号的列表

2.2.2 查询课程贡献度列表

url: /course/contribution

前端提供:

名称类型备注
course_idint课程编号
后端提供:

名称类型备注
list[][username0, nameuser1, username2, ...] name:str一个该课程贡献度排名列表

2.3 资源相关

2.3.1 获取资源信息

url: /course/resource/information

前端提供:

名称类型备注
resource_idint资源编号
后端提供:

名称类型备注
linkstr资源文件路径
upload_timestr上传时间
upload_usernameint上传者
download_username_listlist [username0, username1, username2, ...] username:str下载用户名列表
like_username_listlist [username0, username1, username2, ...] username:str喜欢用户名列表
eva_pos_username_listlist [username0, username1, username2, ...] username:str好评用户名列表
eva_neg_username_listlist [username0, username1, username2, ...] username:str差评用户名列表

3.3.2 好评/差评

url: course/resource/evaluate

前端提供:

名称类型备注
resource_idint资源编号
usernamestr用户名
evaluationint0好评,1差评
后端提供:

名称类型备注
errorint0表成功,其余表示失败

2.4 登录/注册相关

2.4.1 判断用户登录状态

url: /sign/get_user

前端提供:

名称类型备注
this*#可以是当前IP,也可以是其他能够标识用户主机的码
后端提供:

名称类型备注
is_loginbooltrue表已经登录,false表没有登录

2.4.2 注册

url: /sign/register

前端提供:

名称类型备注
usernamestr唯一的用户名
nicknamestr姓名(默认为用户名)
emailstr合法的北航邮箱
passwordstr密码长度为8-20位,包含数字、大小写字母、半角符号
genderint0为保密,1为男,2为女
后端提供:

名称类型备注
errorint0表成功,其余表示失败

2.4.3 登录

url: /sign/login

前端提供:

名称类型备注
usernamestr用户名
passwordstr密码
后端提供:

名称类型备注
errorint0表成功,其余表示失败

2.5 用户相关

2.5.1 获取个人信息

url: /user/information

前端提供:

名称类型备注
usernamestr用户名
后端提供:

名称类型备注
emailstr邮箱(北航)
genderint性别(私密0,男1,女2)
introstr个人介绍
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: