soleil 7 år sedan
förälder
incheckning
66a6afc839

+ 75 - 3
assignment/api/前端api接口设计.md

@@ -118,12 +118,66 @@ delete /assignment/:assignmentId
 ```
 
 
-# 作业结果
+# 作业记录
 
 > url 前缀:/api
 
+## 老师查看作业记录
+
+```http
+get /assignment/:assignmentId/record/teacher
+```
+
+### Response
+
+```json
+{
+  "data": List<RecordVO>
+}
+```
+
+see [RecordVO](../serializer/RecordVO.md)
+
+## 学生查看作业记录
+
+```http
+get /assignment/:assignmentId/record/student
+```
+
+### Response
+
+```json
+{
+  "data": RecordVO
+}
+```
+
+see [RecordVO](../serializer/RecordVO.md)
+
+
 ## 查看作业记录
 
+```http
+get /record/:recordId
+```
+
+### Response
+
+```json
+{
+  "data": RecordVO
+}
+```
+
+see [RecordVO](../serializer/RecordVO.md)
+
+
+# 作业成绩
+
+> url 前缀:/api
+
+## 查看作业成绩
+
 ```http
 get /assignment/:assignmentId/result
 ```
@@ -139,7 +193,24 @@ get /assignment/:assignmentId/result
 see [ResultVO](../serializer/ResultVO.md)
 
 
-## 查看作业下的成绩
+## 查看一个作业记录的成绩
+
+```http
+get /record/:recordId/result
+```
+
+### Response
+
+```json
+{
+  "data": ResultVO
+}
+```
+
+see [ResultVO](../serializer/ResultVO.md)
+
+
+## 查看成绩
 
 ```http
 get /result/:resultId
@@ -153,4 +224,5 @@ get /result/:resultId
 }
 ```
 
-see [ResultVO](../serializer/ResultVO.md)
+see [ResultVO](../serializer/ResultVO.md)
+

+ 2 - 1
assignment/serializer/AssignmentVO.md

@@ -10,7 +10,8 @@
 		- READY:创建成功,但是作业未到开始时间
 		- AVAILABLE:作业开放中
 		- FINISHED:作业已经结束
-	- startAt:开始时间,timestamp(秒)
+	- createAt:创建时间,timestamp(秒)
+	- startAt:开始时间,timestamp
 	- endAt:结束时间,timestamp
 	- type:作业类型,String,枚举值如下
 		- CODE:编程作业

+ 9 - 0
assignment/serializer/RecordVO.md

@@ -0,0 +1,9 @@
+# RecordVO
+- 作业记录
+- 属性:
+	- id:记录编号,Number
+	- assignment:所属作业,NestAssignmentVO
+		- id:编号,Number
+		- name: 作业名称,String
+	- group:所属组,String
+	- url:作业项目地址,String

+ 14 - 7
assignment/serializer/ResultVO.md

@@ -1,10 +1,17 @@
 # ResultVO
-- 作业结果
+- 作业成绩
 - 属性:
 	- id:成绩编号,Number
-	- assignment:所属作业,NestAssignmentVO
-		- id:编号,Number
-		- name: 作业名称,String
-	- group:所属组,String
-	- url:作业项目地址,String
-	- score:总分,Number
+	- assignment:所属作业,Number
+	- record:所属记录,Number
+	- score:总分,Number
+	- detail:细分分数,```List<ScoreVO>```
+
+
+# ScoreVO
+- 成绩条目
+- 属性:
+	- id:条目编号
+	- name:条目名称
+	- score:得分
+	- detail:细分分数,```List<ScoreVO>```,没有细分时,该项为null

+ 4 - 3
course/README.md

@@ -5,6 +5,7 @@
 
 ### 修改记录
 
-| 修改人 | 修改内容  | 修改时间   |
-| ------ | --------- | ---------- |
-| 吴新宇 | 初始化api | 2018/12/18 |
+| 修改人 | 修改内容             | 修改时间   |
+| ------ | -------------------- | ---------- |
+| 吴新宇 | 初始化 api           | 2018/12/18 |
+| 吴新宇 | 新增查看课程详情 api | 2018/12/19 |

+ 18 - 0
course/api/Course-课程.md

@@ -92,3 +92,21 @@ post /register
 ```
 
 see [CourseSerializer](../serializer/CourseSerializer.md)
+
+## 获得课程详情
+
+[STUDENT,TEACHER]
+
+```http
+get /course/:courseId
+```
+
+### Response
+
+```json
+{
+  "data": CourseSerializer
+}
+```
+
+see [CourseSerializer](../serializer/CourseSerializer.md)

+ 1 - 2
user/api/User-用户.md

@@ -35,7 +35,6 @@ post /:userId
 ```json
 {
   "nickname": "nickname",
-  "avatar": "xxxxxxxxxx",
   "bio": "小白白白白白白白白白白白"
 }
 ```
@@ -55,7 +54,7 @@ see [UserSerializer](../serializer/UserSerializer.md)
 [STUDENT,TEACHER]
 
 ```http
-post /:userId
+post /:userId/password
 ```
 
 ### Parameters