重新定义互评API

review/api/Review-互评.md

@@ -4,114 +4,137 @@
 >
 > 示例：**https://xxxxxxxxx/api/review/xxxx**
 
-## 新建互评作业
+## 术语表
 
-[TEACHER]
+| 用词           | 术语     | 含义                                       |
+| -------------- | -------- | ------------------------------------------ |
+| review         | 互评     | -                                          |
+| reviewHomework | 互评作业 | 一次互评作业与一次文档作业相关联           |
+| document       | 文档     | 在一次互评作业中通常需要互评多个小组的文档 |
+|                |
 
-```http
-post /review
-```
 
-### Parameters
 
-```json
-{
-  "homeworkId": Number, //作业id,
-  "beginAt": Number, //开始时间,
-  "endAt": Number, //结束时间,
-  "taskNumber": Number //互评任务数
-}
+
+## TEACHER
+
+### 老师查看互评作业汇总结果
+
+[TEACHER]
+
+```http
+get /sum/:reviewId
 ```
 
-### Response
+#### Response
 
 ```json
 {
-  "data": ReviewSimpleSerializer
+  "detail": ReviewDetailSerializer,
+  "finishPercentage": Double, //完成比例
+   // 学生id和checkList通过数给前端
+   "studentIdCheckListAcceptNumMap": { [groupId]: [checkListNum]},
+   "
 }
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
 
-## 学生申请解释互评作业
+### 老师更新作业评分标准
 
-[STUDENT]
+[TEACHER]
 
 ```http
-post /argue
+post /sum/:reviewId/level
 ```
 
-### Parameters
+#### Parameters
 
 ```json
 {
-  "homeworkId": Number, //作业id,
-  "checkListItemId": Number, //某个checkList的id,
-  "judgeItemId": Number, //某个小组在某个checkList的评价id
-  "remark": String //`{0-100}`
+  [level]: [studentNum(学生通过数)]
 }
 ```
 
-### Response
+#### Response
 
 ```json
 {}
 ```
 
-### Error
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+### 老师获得需要人工复核的文档列表
+
+[TEACHER]
+
+```http
+get /sum/:reviewId/argue
+```
+
+#### Response
 
 ```json
 {
-  "code": 400,
-  "message": "已评审，不可重复评审"
+  "data": Array<ReviewSimpleSerializer> // 需要人工复核的文档
 }
 ```
 
-## 老师查看互评作业列表
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+### 老师获得需要人工复核的文档详情
 
 [TEACHER]
 
+// **reviewId** 作业 id
+// **groupId** 作业小组 id
+
 ```http
-get /teacher/course/:courseId/review
+get /sum/:reviewId/argue/:groupId
 ```
 
-### Response
+#### Response
 
 ```json
 {
-    "data": Array<ReviewSimpleSerializer>
+  "data": ResultSerializer // 需要人工复核的文档
 }
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+see [ResultSerializer](../serializer/ResultSerializer.md)
 
-## 老师查看互评作业详情
+### 老师提交需要复核文档的结果
 
 [TEACHER]
 
 ```http
-get /teacher/review/:reviewId
+post /sum/:reviewId/argue/:groupId
 ```
 
-### Response
+#### Parameters
 
 ```json
 {
-  "data": ReviewDetailSerializer
+  "score": double // 分数
 }
 ```
 
-see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
+#### Response
 
-## 学生查看互评作业列表
+```json
+{}
+```
 
-[STUDENT]
+
+### 老师查看互评作业列表
+
+[TEACHER]
 
 ```http
-get /student/course/:courseId/review
+get /teacher/course/:courseId/review
 ```
 
-### Response
+#### Response
 
 ```json
 {
@@ -121,15 +144,15 @@ get /student/course/:courseId/review
 
 see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
 
-## 学生查看互评作业详情
+### 老师查看互评作业详情
 
-[STUDENT]
+[TEACHER]
 
 ```http
-get /student/review/:reviewId
+get /teacher/review/:reviewId
 ```
 
-### Response
+#### Response
 
 ```json
 {
@@ -139,171 +162,173 @@ get /student/review/:reviewId
 
 see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
 
-## 学生做互评作业
+### 新建互评作业
 
-[STUDENT]
+[TEACHER]
 
 ```http
-post /student/review/:reviewId
+post /review
 ```
 
-### Parameters
+#### Parameters
 
 ```json
 {
-  "data": Array<CheckListItemSerializer>
+  "homeworkId": Number, //作业id,
+  "beginAt": Number, //开始时间,
+  "endAt": Number, //结束时间,
+  "taskNumber": Number //互评任务数
 }
 ```
 
-### Response
+#### Response
 
 ```json
 {
-    "data": Array<CheckListItemSerializer>
+  "data": ReviewSimpleSerializer
 }
 ```
 
-see [CheckListItemSerializer](../serializer/CheckListItemSerializer.md)
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
 
-## 学生查看互评结果
+
+## STUDENT
+
+### 学生申请解释互评作业
 
 [STUDENT]
 
 ```http
-get /student/course/:courseId/result
+post /argue
 ```
 
-### Response
+#### Parameters
 
 ```json
 {
-    "data": Array<ReviewSimpleSerializer>
+  "homeworkId": Number, //作业id,
+  "checkListItemId": Number, //某个checkList的id,
+  "judgeItemId": Number, //某个小组在某个checkList的评价id
+  "remark": String //`{0-100}`
 }
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+#### Response
+
+```json
+{}
+```
 
-## 学生查看某次互评结果
+#### Error
+
+```json
+{
+  "code": 400,
+  "message": "已评审，不可重复评审"
+}
+```
+
+
+
+### 学生查看互评作业列表
 
 [STUDENT]
 
 ```http
-get /student/review/:reviewId/result
+get /student/course/:courseId/review
 ```
 
-### Response
+#### Response
 
 ```json
 {
-  "data": ResultSerializer
+    "data": Array<ReviewSimpleSerializer>
 }
 ```
 
-see [ResultSerializer](../serializer/ResultSerializer.md)
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
 
-## 老师查看互评作业汇总结果
+### 学生查看互评作业详情
 
-[TEACHER]
+[STUDENT]
 
 ```http
-get /sum/:reviewId
+get /student/review/:reviewId
 ```
 
-### Response
+#### Response
 
 ```json
 {
-  "detail": ReviewDetailSerializer,
-  "finishPercentage": Double, //完成比例
-   // 学生id和checkList通过数给前端
-   "studentIdCheckListAcceptNumMap": { [groupId]: [checkListNum]},
-   "
+  "data": ReviewDetailSerializer
 }
 ```
 
 see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
 
-## 老师更新作业评分标准
+### 学生做互评作业
 
-[TEACHER]
+[STUDENT]
 
 ```http
-post /sum/:reviewId/level
+post /student/review/:reviewId
 ```
 
-### Parameters
+#### Parameters
 
 ```json
 {
-  [level]: [studentNum(学生通过数)]
+  "data": Array<CheckListItemSerializer>
 }
 ```
 
-### Response
+#### Response
 
 ```json
-{}
+{
+    "data": Array<CheckListItemSerializer>
+}
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+see [CheckListItemSerializer](../serializer/CheckListItemSerializer.md)
 
-## 老师获得需要人工复核的文档列表
+### 学生查看互评结果
 
-[TEACHER]
+[STUDENT]
 
 ```http
-get /sum/:reviewId/argue
+get /student/course/:courseId/result
 ```
 
-### Response
+#### Response
 
 ```json
 {
-  "data": Array<ReviewSimpleSerializer> // 需要人工复核的文档
+    "data": Array<ReviewSimpleSerializer>
 }
 ```
 
 see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
 
-## 老师获得需要人工复核的文档详情
+### 学生查看某次互评结果
 
-[TEACHER]
-
-// **reviewId** 作业 id
-// **groupId** 作业小组 id
+[STUDENT]
 
 ```http
-get /sum/:reviewId/argue/:groupId
+get /student/review/:reviewId/result
 ```
 
-### Response
+#### Response
 
 ```json
 {
-  "data": ResultSerializer // 需要人工复核的文档
+  "data": ResultSerializer
 }
 ```
 
 see [ResultSerializer](../serializer/ResultSerializer.md)
 
-## 老师提交需要复核文档的结果
 
-[TEACHER]
-
-```http
-post /sum/:reviewId/argue/:groupId
-```
 
-### Parameters
+## 数据定义
 
-```json
-{
-  "score": double // 分数
-}
-```
-
-### Response
-
-```json
-{}
-```