新增 review api

.gitignore

@@ -0,0 +1 @@
+.DS_Store

review/README.md

@@ -2,3 +2,9 @@
 
 - 【后端】徐翔哲
 - 【前端】吴新宇
+
+### 修改记录
+
+| 修改人 | 修改内容           | 修改时间   |
+| ------ | ------------------ | ---------- |
+| 吴新宇 | 初次提交Review api | 2018/12/23 |

review/api/Review-互评.md

@@ -0,0 +1,283 @@
+# Review - 互评
+
+> url 前缀：**review**
+>
+> 示例：**https://xxxxxxxxx/api/review/xxxx**
+
+## 新建互评作业
+
+[TEACHER]
+
+```http
+post /review
+```
+
+###Parameters
+
+```json
+{
+  "homeworkId": Number, //作业id,
+  "beginAt": Number, //开始时间,
+  "endAt": Number, //结束时间,
+  "taskNumber": Number //互评任务数
+}
+```
+
+### Response
+
+```json
+{
+  "data": ReviewSimpleSerializer
+}
+```
+
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+## 学生申请解释互评作业
+
+[STUDENT]
+
+```http
+post /argue
+```
+
+### Parameters
+
+```json
+{
+  "homeworkId": Number, //作业id,
+  "checkListItemId": Number, //某个checkList的id,
+  "remark": String //`{0-100}`
+}
+```
+
+### Response
+
+```json
+{}
+```
+
+### Error
+
+- status: 470 已评审，不可重复评审
+
+## 老师查看互评作业列表
+
+[TEACHER]
+
+```http
+get /teacher/course/:courseId/review
+```
+
+### Response
+
+```json
+{
+    "data": Array<ReviewSimpleSerializer>
+}
+```
+
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+## 老师查看互评作业详情
+
+[TEACHER]
+
+```http
+get /teacher/review/:reviewId
+```
+
+### Response
+
+```json
+{
+  "data": ReviewDetailSerializer
+}
+```
+
+see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
+
+## 学生查看互评作业列表
+
+[STUDENT]
+
+```http
+get /student/course/:courseId/review
+```
+
+### Response
+
+```json
+{
+    "data": Array<ReviewSimpleSerializer>
+}
+```
+
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+## 学生查看互评作业详情
+
+[STUDENT]
+
+```http
+get /student/review/:reviewId
+```
+
+### Response
+
+```json
+{
+  "data": ReviewDetailSerializer
+}
+```
+
+see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
+
+## 学生做互评作业
+
+[STUDENT]
+
+```http
+post /student/review/:reviewId
+```
+
+### Parameters
+
+```json
+{
+  "data": Array<CheckListItemSerializer>
+}
+```
+
+### Response
+
+```json
+{
+    "data": Array<CheckListItemSerializer>
+}
+```
+
+see [CheckListItemSerializer](../serializer/CheckListItemSerializer.md)
+
+## 学生查看互评结果
+
+[STUDENT]
+
+```http
+get /student/course/:courseId/result
+```
+
+### Response
+
+```json
+{
+    "data": Array<ReviewSimpleSerializer>
+}
+```
+
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+## 学生查看某次互评结果
+
+[STUDENT]
+
+```http
+get /student/review/:reviewId/result
+```
+
+### Response
+
+```json
+{
+  "data": ResultSerializer
+}
+```
+
+see [ResultSerializer](../serializer/ResultSerializer.md)
+
+## 老师查看互评作业汇总结果
+
+[TEACHER]
+
+```http
+get /sum/:reviewId
+```
+
+### Response
+
+```json
+{
+  "detail": ReviewDetailSerializer,
+  "finishPerdentage": Double, //完成比例
+   // 学生id和checkList通过数给前端
+   "studentIdCheckListAcceptNumMap": { [groupId]: [checkListNum]},
+   "
+}
+```
+
+see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
+
+## 老师更新作业评分标准
+
+[TEACHER]
+
+```http
+post /sum/:reviewId/level
+```
+
+### Parameters
+
+```json
+{
+  [level]: [studentNum(学生通过数)]
+}
+```
+
+### Response
+
+```json
+{}
+```
+
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+## 老师获得需要人工复核的文档
+
+[TEACHER]
+
+```http
+get /sum/:reviewId/argue
+```
+
+### Response
+
+```json
+{
+  "data": Array<ReviewSimpleSerializer> // 需要人工复核的文档
+}
+```
+
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+
+## 老师提交需要复核文档的结果
+
+[TEACHER]
+
+```http
+get /sum/:reviewId/argue/:reviewId
+```
+
+### Parameters
+
+```json
+{
+  "groupName": sec, //小组名
+  "score": double // 分数
+}
+```
+
+### Response
+
+```json
+{}
+```

review/serializer/CheckListItemSerializer.md

@@ -0,0 +1,11 @@
+# CheckListItemSerializer
+
+互评作业详细实体类
+
+## Attributes
+
+- fid : **Number** - 类型 id
+- content : **String** - 名称 | {2-100}
+- level : **Number** - 用户的评级 | 0 or 1
+- comment : **String** - 用户的备注 | {0-200}
+- explain : **String** - 老师的说明 | {0-200}

review/serializer/ResultSerializer.md

@@ -0,0 +1,8 @@
+### Result Serializer
+
+互评作业的结果
+
+#### Attributes
+
+- docContent: String - 文档内容
+- checkList: - accept: Bool - 是否通过 - groupName: String - 小组名 - remark: String - 备注

review/serializer/ReviewDetailSerializer.md

@@ -0,0 +1,14 @@
+# ReviewDetailSerializer
+
+互评作业详细实体类
+
+## Attributes
+
+- id : **Number** - 互评 id
+- name : **String** - 对应的文档作业名称 | {2-100}
+- course : [**CourseSerializer**](../../course/serializer/CourseSerializer.md) - 所属课程
+- beginAt : **Number** - 开始时间 | `timestamp`
+- endAt : **Number** - 结束时间 | `timestamp`
+- docContent : **String** - 作业内容
+- checkList : Array<[**CheckListItemSerializer**](./CheckListItemSerializer.md)>
+- group : [**GroupSerializer**](../../course/serializer/GroupSerializer.md)

review/serializer/ReviewSimpleSerializer.md

@@ -0,0 +1,11 @@
+# ReviewSimpleSerializer
+
+互评作业列表实体类
+
+## Attributes
+
+- id : **Number** - 互评 id
+- name : **String** - 对应的文档作业名称 | {2-100}
+- course : [**CourseSerializer**](../../course/serializer/CourseSerializer.md) - 所属课程
+- beginAt : **Number** - 开始时间 | `timestamp`
+- endAt : **Number** - 结束时间 | `timestamp`