# KuaiKe

**Repository Path**: kuada/kuai-ke

## Basic Information

- **Project Name**: KuaiKe
- **Description**: 快课后端程序
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-07-07
- **Last Updated**: 2022-04-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#快课 API文档

备注：前端发送的键值对的值用#[XXX]来表示

#1 登录功能
请求： /login
方法：post
参数: 
	username = XXX
	password = XXX
	timer = XXX
响应: 
	ResponseHeader: 
		token:  加密后的登录数据
	body: "true"或者"false"

#2 修改密码功能
请求:  /updatePassword
方法:  post
参数：
	username  = #{username}
	oPassword = #{oPassword}
	nPassword = #{nPassword}
响应:
	body:  "密码修改成功"或者"密码修改失败"

#3 加载课程数据
请求:  /indexload
方法:  get
参数:  null
请求头需要包含一个保存登录信息的cookie
响应：
	body:   
		student： Json:{{"classId":XXX , "cName":XXX , "className":XXX , "tName":XXX , "url":XXX} , {...} , {...} }
		teacher： Json:{{"classId":${classId} , "uId":${uId} , "courseId":${courseId} , "className":${className} , 
						"classroom":${classroom} , "pictureUrl":${url}},{...},{...}}

#4 加载课程图片
请求:  /get_picture
方法:  get
参数：	classId = #[classId]
响应：      image/jpeg

#5 加载用户头像
请求：/get_user_picture
方法： get
参数：	username = #[username]
响应：	image/jpeg

#6  修改用户头像
请求：  /update_user_picture
方法：  get
参数:	username = #[username]
	image/jpeg
响应：
	body:  "头像修改成功" 或 "头像修改失败"

#7   教师作业文件上传
请求：  /t_submit_f
方法：  post
参数：  Post-multipart/form-data
	   (1)key = data
  	   value = Json:{"classId":${班级编号} , "hwId":${作业id} ,
					"tag":${题号}} , "fileId":${第几份文件} , 
					"filename":${文件名} , "type":${文件类型} }
	   (2)key = file
		  value = bytes[]
响应：   url =  http://106.52.176.225/<router>?classId=${班级编号}&
				hw=${作业名}&uId=${用户名}&tag=${题号}&fileId=${第
				几份文件}&Id=${CRC3校验码+ md5校验码} 

#8   教师下载作业图片
请求：   /t_down_f?classId=${班级编号}&
		hw=${作业名}&uId=${用户名}&tag=${题号}&fileId=${第
		几份文件}&Id=${CRC3校验码+ md5校验码} 
方法：  get
响应：  file or picture

#9    获取上传进度条
请求：   /getUpLoadPercent
方法：   get
参数：   filename = ${上传的文件名文件名}
响应：   string  (for example: 20%)

#10   教师上传作业信息
请求：   /t_submit_m
方法：    post
参数：    RequestHeader:
				classId : #{班级编号}
				hwId:  #{作业id}
				hwName: #{作业名称}
		 RequestBody:
				Json List<Map>{"tag":${题号},"title":${题目},
					 "type":${题目类型},"ansy":${参考答案},
					 "pic":${题目图片的url列表},"file":${file},"isSubmit":${1 or 0}}
响应：    正常响应："操作成功"   
		 异常响应："操作失败"

#11    学生作业文件上传
请求：   /s_submit_f
方法：   post
参数：  Post-multipart/form-data
		(1)key = data
           value = Json:{"classId":${班级编号} , "hwId":${作业名称} ,
						"tag":${题号}} , "fileId":${第几份文件} ,
						"filename":${文件名} , "type":${文件类型} }
		(2)key = file
		   value = bytes[]
响应:     url:   http://106.52.176.225/<router>?classId=${班级编号}
					&hw=${作业名}&uId=${用户名}&tag=${题号}&fileId=$
					{第几份文件}&Id=${CRC3校验码+md5校验码}

#12     作业文件下载
请求：    http://106.52.176.225/<router>?classId=${班级编号}
			&hw=${作业名}&uId=${用户名}&tag=${题号}&fileId=$
			{第几份文件}&Id=${CRC3校验码+md5校验码}
方法:     get
响应：  file or picture

#13   学生上传作业信息
请求：   /s_submit_m
方法：    post
参数：    RequestHeader:
		    uId:      #{学生id}
			classId : #{班级编号}
			hwId:  	  #{作业名}
		 RequestBody:
			Json List<Map>{"tag":${题号},"title":${题目},
							"type":${题目类型},"ansy":${参考答案},
							"pic":${题目图片的url列表},"file":${file}}
响应：    正常响应："操作成功"   
		 异常响应："操作失败"

#14   获取学生的作业完成状态
请求：    /getHomeworkStatus
方法：    get和post均可
参数：    RequestHeader:
			token  :  加密后的登录数据
			classId:  ${classId}

#15   获取用户昵称
请求：    /get_user
方法:     post
参数：    RequestHeader:
			token  :  加密后的登录数据
响应：    ResponseBody:
			${name}

#16    生成作业随机码
请求：   /setHwId
参数：   RequestHeader:
			token : 加密后的登录数据
		RequestParam: classId
响应：   随机码

#17		获取作业接口
请求：   /getHw
参数：	RequestParam: classId  ,  hwId
		RequestHeader:	token
响应：	JSON字符串，其中的参数包括:hwName和homeworkMessage,
		而homeworkMessage对应的value又是一个Json列表字符串，如下：
		[{"tag":"1","title":"1","type":"选择题","ans":"A","pic":["url1","url2","url3"],"file":["file1","file2"]}]