Selaa lähdekoodia

[修改]完善题目模块API

soleil 7 vuotta sitten
vanhempi
commit
2b4ab92a92

+ 68 - 44
problem/api/Problem-题目.md

@@ -2,14 +2,14 @@
 
 > url 前缀:**problem**
 >
-> 示例:**https://xxxxxxxxx/api/problems/xxxx**
+> 示例:**https://xxxxxxxxx/api/problem/xxxx**
 
 ## 获取全部题目分类
 
 [TEACHER]
 
 ```http
-get /teacher
+get /teacher/problemType
 ```
 
 ### Response
@@ -19,86 +19,101 @@ get /teacher
   "data": Array<String>
 }
 ```
-- data: 数组形式返回所有题目分类
 
 ## 按题目分类获得题目(分页)
 
 [TEACHER]
 
 ```http
-post /teacher/{assignmenttype}/problems
+get /teacher/problems
 ```
 
 ### Parameters
 
-```json
-{
-  "type": string,  
-  "page": number,
-  "num": number,
-}
-```
-- type: 题目分类
-- pageIndex: 当前页数
-- pageNum: 一页的题目数量
+| Name     | Type   | Description      |
+| -------- | ------ | ---------------- |
+| type | String | 题目类型 |
+| page | number | 当前页数 |
+| limit | number | 每页的题目数量 |
+
 
 ### Response
 
 ```json
 {
-  "data": Array<ProblemSerializer>
+  "data": Array<ProblemSerializer>,
+  "pageNum": number,
 }
 ```
+- pageNum: 总页数
 
 see [ProblemSerializer](../serializer/ProblemSerializer.md)
 
-## 根据关键字进行模糊查找
+## 根据作业类型获得题目(分页)
 
 [TEACHER]
 
 ```http
-post /teacher
+get /teacher/problems
 ```
+
 ### Parameters
 
-```json
-//关键字模糊搜索是否分页?
-{
-  "keyword": string,
-  "type": string,
-}
-```
-- type: 题目分类
-- keyword: 关键字
-- pageNum: 一页的题目数量
+| Name     | Type   | Description      |
+| -------- | ------ | ---------------- |
+| assignmenttype | String | 作业类型|
+| page | number | 当前页数 |
+| limit | number | 每页的题目数量 |
 
 ### Response
 
 ```json
 {
-  "data": Array<ProblemSerializer>
+  "data": Array<ProblemSerializer>,
+  "pageNum": number,
 }
 ```
+- pageNum: 总页数
 
 see [ProblemSerializer](../serializer/ProblemSerializer.md)
 
-## 查看单个题目
+## 根据关键字进行模糊查找
 
 [TEACHER]
 
 ```http
-post /teacher
+get /teacher/keyword
 ```
 
-###Parameters
+### Parameters
+
+| Name     | Type   | Description      |
+| -------- | ------ | ---------------- |
+| keyword | String | 用户查找关键字 |
+
+### Response
 
 ```json
 {
-  "id": number,
+  "data": Array<ProblemSerializer>
 }
 ```
 
+see [ProblemSerializer](../serializer/ProblemSerializer.md)
+
+## 根据题目ID查看单个题目
+
+```http
+get /problemDetail
+```
+### Parameters
+
+| Name     | Type   | Description      |
+| -------- | ------ | ---------------- |
+| problemId | number | 题目ID |
+
 ### Response
+
 ```json
 {
   "data": ProblemSerializer,
@@ -108,14 +123,14 @@ see [ProblemSerializer](../serializer/ProblemSerializer.md)
 
 
 ***
-# 以下为二期开发内容
+## 以下为二期开发内容
 
 ## 上传单个题目
 
 [TEACHER]
 
 ```http
-post /teacher
+post /teacher/problemDetail
 ```
 ###Parameters
 
@@ -129,6 +144,7 @@ post /teacher
 
 ```json
 {
+  "msg": string,
   "id": number,
 }
 ```
@@ -140,7 +156,7 @@ see [ProblemSerializer](../serializer/ProblemSerializer.md)
 [TEACHER]
 
 ```http
-post /teacher/{problemId}/updateProblem
+put /teacher/problemUpdate
 ```
 ###Parameters
 
@@ -165,23 +181,31 @@ see [ProblemSerializer](../serializer/ProblemSerializer.md)
 [TEACHER]
 
 ```http
-post /teacher/{problemId}/delete
+delete /teacher/problemDelete
 ```
 
-## 更新文件
-
-[TEACHER]
+### Parameters
 
-```http
-post /teacher/{problemId}/updatefile
-```
+| Name     | Type   | Description      |
+| -------- | ------ | ---------------- |
+| problemId | number | 题目ID |
 
-###Parameters
+###Response
 
 ```json
 {
-  "data": FileSerializer,
+  "msg": string,
 }
 ```
 
+
+## 更新文件(待定)
+
+[TEACHER]
+
+```http
+put /teacher/fileUpdate
+```
+
+
 see [FileSerializer](../serializer/FileSerializer.md)

+ 4 - 4
problem/serializer/FileSerializer.md

@@ -3,7 +3,7 @@
 文件的基本信息
 
 ## Attributes
-- filename: **String**, 文件名
-- content:  **byte[]**, 文件内容
-- uploader: **Long**, 上传者ID
-- size: **long**, 文件大小
+- filename: **String** - 文件名 | `{2-100}`
+- content:  **Array<String>** -  文件内容
+- size: **number** -  文件大小 | `[0-9]*`
+- uploader: **number**, 上传者ID  

+ 9 - 5
problem/serializer/ProblemSerializer.md

@@ -3,10 +3,14 @@
 题目的基本信息
 
 ## Attributes
-- AssignmentType : **enum** - 题目所属作业类型
-- type: **enm** - 题目类型
-- name: **String** - 题目名称
-- description: **String - 题目描述
-- creator: **Long** - 创建者ID
+- AssignmentType : **String** - 题目所属作业类型 | `{1-10}`
+- type: **String** - 题目类型 | `{1-10}`
+- name: **String** - 题目名称 | `{2-100}`
+- description: **String** - 题目描述
+- creator: **number** - 创建者ID
+- expectTime: **number** - 预计完成时间 `[0-9]{1-3}`
+- difficulty: **number** - 题目难度 `[0-9]`
 - file:
 [**FileSerializer**](./FileSerializer.md) - 文件信息
+
+<!-- TBD:题目难度、预计完成时间数据类型 -->