Merge branch 'master' of http://47.100.18.120:3000/SEEC-II-DOC/API-DOC

course/README.md

@@ -8,4 +8,5 @@
 | 修改人 | 修改内容             | 修改时间   |
 | ------ | -------------------- | ---------- |
 | 吴新宇 | 初始化 api           | 2018/12/18 |
-| 吴新宇 | 新增查看课程详情 api | 2018/12/19 |
+| 吴新宇 | 新增查看课程详情 api | 2018/12/19 |
+| 吴新宇 | fix todo 新增异常    | 2018/12/28 |

course/api/Course-课程.md

@@ -65,11 +65,17 @@ post /teacher
 }
 ```
 
-//TODO
-课程名重复 课程选课码重复
-
 see [CourseSerializer](../serializer/CourseSerializer.md)
 
+### Error
+
+```json
+{
+  "code": 400,
+  "message": "课程名重复" | "课程选课码重复"
+}
+```
+
 ## 学生通过选课码加入课程
 
 [STUDENT]
@@ -94,17 +100,17 @@ post /register
 }
 ```
 
+see [CourseSerializer](../serializer/CourseSerializer.md)
+
 ### Error
 
 ```json
 {
   "code": 400,
-  "message": "选课码不存在" | "已经加入课程" | "输入格式不正确"
+  "message": "选课码不存在" | "已经加入课程"
 }
 ```
 
-see [CourseSerializer](../serializer/CourseSerializer.md)
-
 ## 获得课程详情
 
 [STUDENT,TEACHER]

problem/api/Problem-题目.md

@@ -30,10 +30,10 @@ get /teacher/problems
 
 ### Parameters
 
-| Name     | Type   | Description      |
-| -------- | ------ | ---------------- |
-| type | String | 题目类型 |
-| page | number | 当前页数 |
+| Name  | Type   | Description    |
+| ----- | ------ | -------------- |
+| type  | String | 题目类型       |
+| page  | number | 当前页数       |
 | limit | number | 每页的题目数量 |
 
 
@@ -59,11 +59,11 @@ get /teacher/problems
 
 ### Parameters
 
-| Name     | Type   | Description      |
-| -------- | ------ | ---------------- |
-| assignmenttype | String | 作业类型|
-| page | number | 当前页数 |
-| limit | number | 每页的题目数量 |
+| Name           | Type   | Description    |
+| -------------- | ------ | -------------- |
+| assignmenttype | String | 作业类型       |
+| page           | number | 当前页数       |
+| limit          | number | 每页的题目数量 |
 
 ### Response
 
@@ -87,8 +87,8 @@ get /teacher/keyword
 
 ### Parameters
 
-| Name     | Type   | Description      |
-| -------- | ------ | ---------------- |
+| Name    | Type   | Description    |
+| ------- | ------ | -------------- |
 | keyword | String | 用户查找关键字 |
 
 ### Response
@@ -144,11 +144,17 @@ post /teacher/problem
 }
 ```
 
-//TODO:
-- 题目名称重复
-
 see [ProblemSerializer](../serializer/ProblemSerializer.md)
 
+### Error
+
+```json
+{
+  "code": 400,
+  "message": "题目名称重复",
+}
+```
+
 ## 更新题目
 
 [TEACHER]
@@ -185,9 +191,9 @@ delete /teacher/problemDelete
 
 ### Parameters
 
-| Name     | Type   | Description      |
-| -------- | ------ | ---------------- |
-| problemId | number | 题目ID |
+| Name      | Type   | Description |
+| --------- | ------ | ----------- |
+| problemId | number | 题目ID      |
 
 ###Response
 

review/README.md

@@ -5,6 +5,7 @@
 
 ### 修改记录
 
-| 修改人 | 修改内容           | 修改时间   |
-| ------ | ------------------ | ---------- |
-| 吴新宇 | 初次提交Review api | 2018/12/23 |
+| 修改人 | 修改内容                                     | 修改时间   |
+| ------ | -------------------------------------------- | ---------- |
+| 吴新宇 | 初次提交Review api                           | 2018/12/23 |
+| 吴新宇 | 更新resultSerializer的定义，修改申请评审参数 | 2018/12/28 |

review/api/Review-互评.md

@@ -47,6 +47,7 @@ post /argue
 {
   "homeworkId": Number, //作业id,
   "checkListItemId": Number, //某个checkList的id,
+  "judgeItemId": Number, //某个小组在某个checkList的评价id
   "remark": String //`{0-100}`
 }
 ```
@@ -59,7 +60,12 @@ post /argue
 
 ### Error
 
-- status: 470 已评审，不可重复评审
+```json
+{
+  "code": 400,
+  "message": "已评审，不可重复评审"
+}
+```
 
 ## 老师查看互评作业列表
 

review/serializer/ResultSerializer.md

@@ -1,8 +1,16 @@
-### Result Serializer
+### ReviewResultSerializer
 
 互评作业的结果
 
 #### Attributes
 
-- docContent: String - 文档内容
-- checkList: - accept: Bool - 是否通过 - groupName: String - 小组名 - remark: String - 备注
+- id : **Number** - 结果 id
+- detail : [**ReviewDetailSerializer**](./ReviewDetailSerializer)
+- level : **String** - 文档等级
+- checkListResult : **Array<Object>** - 详细评价结果
+  - id : **Number** - checkListResult id
+  - checkListItem : [**CheckListItemSerializer**](./CheckListItemSerializer) - 对应的 checkListItem
+  - results : **Array<Object>** - 各个小组的评价
+    - judgeItemId : **Number** - 某个小组的评价 id
+    - level : **Number** - 小组作出的评价 | 0 或 1
+    - comment : **String** - 小组做出的备注 |

user/README.md

@@ -5,8 +5,8 @@
 
 ### 修改记录
 
-| 修改人 | 修改内容         | 修改时间   |
-| ------ | ---------------- | ---------- |
-| 吴新宇 | 初始化api        | 2018/12/18 |
-| 吴新宇 | 新增很多问题TODO | 2018/12/24 |
-
+| 修改人 | 修改内容          | 修改时间   |
+| ------ | ----------------- | ---------- |
+| 吴新宇 | 初始化api         | 2018/12/18 |
+| 吴新宇 | 新增很多问题TODO  | 2018/12/24 |
+| 吴新宇 | fix todo 新增异常 | 2018/12/28 |

user/api/Auth-权限.md

@@ -47,9 +47,6 @@ post /register
 }
 ```
 
-//TODO
-角色，学生学号
-
 ### Response
 
 ```json
@@ -58,8 +55,13 @@ post /register
 }
 ```
 
-//TODO
+see [UserSerializer](../serializer/UserSerializer.md)
 
-- 重复
+### Error
 
-see [UserSerializer](../serializer/UserSerializer.md)
+```json
+{
+  "code": 400,
+  "message": "用户名重复"
+}
+```

user/api/User-用户.md

@@ -74,7 +74,13 @@ post /:userId/password
 }
 ```
 
-//TODO
-旧密码错
-
 see [UserSerializer](../serializer/UserSerializer.md)
+
+### Error
+
+```json
+{
+  "code": 400,
+  "message": "旧密码错"
+}
+```