init

README.md

@@ -15,7 +15,7 @@
 
 1. README 声明负责人
 2. api 文件夹 （用于存放所有 api）
-3. serializer 文件夹 （用于存放所有 api 中提到的对象  细则）
+3. serializer 文件夹 （用于存放所有 api 中提到的对象  细则）
 
 #### example：
 
@@ -32,15 +32,15 @@ user
 
 #### 前缀与规范
 
-1. 所有后端 api 务必至少添加前缀：/api
-2. restful 规范， 以数据为中心，每个数据 **务必** 返回 id
-3. 所有返回值均为 **对象** ，**禁止** 使用 bool string array等类型作为json返回值
+1. 所有后端 api 务必至少添加前缀：/api
+2. restful 规范， 以数据为中心，每个数据 **务必** 返回 id
+3. 所有返回值均为 **对象** ，**禁止** 使用 bool string array等类型作为json返回值
 
 #### api 文件命名
 
-[模块英文命名]-[解释].md
+[模块英文命名]-[解释].md
 
-example: User-用户.md
+example: User-用户.md
 
 #### api 文件内容结构
 
@@ -51,9 +51,9 @@ user
 >
 > 示例：**https://xxxxxxxxx/api/user/xxxx**
 
-##  请求名称
+##  请求名称
 
-⬇️ 为路径参数格式 :userId 表示变量 
+⬇️ 为路径参数格式 :userId 表示变量 
 
 ```http
 post /:userId
@@ -61,7 +61,7 @@ post /:userId
 
 ### Parameters
 
-⬇️ 为 post body 中的参数格式
+⬇️ 为 post body 中的参数格式
 
 ```json
 {
@@ -71,7 +71,7 @@ post /:userId
 }
 ```
 
-⬇️ 为问号传参格式 example： user?userId=1
+⬇️ 为问号传参格式 example： user?userId=1
 
 | Name   | Type   | Description       |
 | ------ | ------ | ----------------- |

course/README.md

@@ -0,0 +1,10 @@
+### 负责人
+
+- 【后端】徐翔哲
+- 【前端】吴新宇
+
+### 修改记录
+
+| 修改人 | 修改内容  | 修改时间   |
+| ------ | --------- | ---------- |
+| 吴新宇 | 初始化api | 2018/12/18 |

course/api/Course-课程.md

@@ -0,0 +1,94 @@
+# Course - 老师
+
+> url 前缀：**course**
+>
+> 示例：**https://xxxxxxxxx/api/course/xxxx**
+
+## 老师获得所有自己的课程
+
+[TEACHER]
+
+```http
+get /teacher
+```
+
+### Response
+
+```json
+{
+  "data":Array<CourseSerializer>
+}
+```
+
+see [CourseSerializer](../serializer/CourseSerializer.md)
+
+## 学生获得所有自己的课程
+
+[STUDENT]
+
+```http
+get /student
+```
+
+### Response
+
+```json
+{
+  "data":Array<CourseSerializer>
+}
+```
+
+see [CourseSerializer](../serializer/CourseSerializer.md)
+
+## 老师创建自己的课程
+
+[TEACHER]
+
+```http
+post /teacher
+```
+
+### Parameters
+
+```json
+{
+  "name": string,
+  "code": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": CourseSerializer
+}
+```
+
+see [CourseSerializer](../serializer/CourseSerializer.md)
+
+## 学生通过选课码加入课程
+
+[STUDENT]
+
+```http
+post /register
+```
+
+### Parameters
+
+```json
+{
+  "code": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": CourseSerializer
+}
+```
+
+see [CourseSerializer](../serializer/CourseSerializer.md)

course/api/Group-小组.md

@@ -0,0 +1,81 @@
+# Group - 小组
+
+> url 前缀：**group**
+>
+> 示例：**https://xxxxxxxxx/api/group/xxxx**
+
+## 学生创建小组
+
+[STUDENT]
+
+```http
+post /
+```
+
+### Parameters
+
+```json
+{
+  "name": string,
+  "courseId": number
+}
+```
+
+### Response
+
+```json
+{
+  "data": GroupSerializer
+}
+```
+
+see [GroupSerializer](../serializer/GroupSerializer.md)
+
+## 学生通过选组码加入小组
+
+[STUDENT]
+
+```http
+put /
+```
+
+### Parameters
+
+```json
+{
+  "code": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": GroupSerializer
+}
+```
+
+see [GroupSerializer](../serializer/GroupSerializer.md)
+
+## 学生查看自己的小组
+
+[STUDENT]
+
+```http
+get /
+```
+### Parameters
+
+| Name     | Type   | Description      |
+| -------- | ------ | ---------------- |
+| courseId | number | 根据课程查看小组 |
+
+### Response
+
+```json
+{
+  "data": Array<GroupSerializer>
+}
+```
+
+see [GroupSerializer](../serializer/GroupSerializer.md)

course/serializer/CourseSerializer.md

@@ -0,0 +1,10 @@
+# CourseSerializer
+
+课程的基本信息
+
+## Attributes
+
+- id : **Number** - 课程 id
+- name : **String** - 课程名称 | `{2-100}`
+- code : **String** - 选课码 | `[a-zA-Z0-9]{1-10}`
+- teacher : [**UserSerializer**](../../user/serializer/UserSerializer.md) - 老师信息

course/serializer/GroupSerializer.md

@@ -0,0 +1,10 @@
+# GroupSerializer
+
+小组的基本信息
+
+## Attributes
+
+- id : **Number** - 小组 id
+- name : **String** - 小组名称 | `[a-zA-Z0-9\-]{2-50}`
+- code : **String** - 选课码 | `[a-zA-Z0-9]{1-10}`
+- members : Array<[**UserSerializer**](../../user/serializer/UserSerializer.md)> - 组员信息

user/README.md

@@ -2,3 +2,10 @@
 
 - 【后端】徐翔哲
 - 【前端】吴新宇
+
+### 修改记录
+
+| 修改人 | 修改内容  | 修改时间   |
+| ------ | --------- | ---------- |
+| 吴新宇 | 初始化api | 2018/12/18 |
+

user/api/Auth-权限.md

@@ -0,0 +1,56 @@
+# User - 用户
+
+> url 前缀：**auth**
+>
+> 示例：**https://xxxxxxxxx/api/auth/xxxx**
+
+## 登录
+
+```http
+post /login
+```
+
+### Parameters
+
+```json
+{
+  "username": string,
+  "password": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": UserSerializer
+}
+```
+
+see [UserSerializer](../serializer/UserSerializer.md)
+
+## 注册
+
+```http
+post /register
+```
+
+### Parameters
+
+```json
+{
+  "nickname": string | null,
+  "username": string,
+  "password": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": UserSerializer
+}
+```
+
+see [UserSerializer](../serializer/UserSerializer.md)

user/api/User-用户.md

@@ -6,6 +6,8 @@
 
 ## 获得用户信息
 
+[STUDENT,TEACHER]
+
 ```http
 get /:userId
 ```
@@ -22,7 +24,7 @@ see [UserSerializer](../serializer/UserSerializer.md)
 
 ## 修改用户信息
 
-[需要认证]
+[STUDENT,TEACHER]
 
 ```http
 post /:userId
@@ -47,3 +49,30 @@ post /:userId
 ```
 
 see [UserSerializer](../serializer/UserSerializer.md)
+
+## 修改密码
+
+[STUDENT,TEACHER]
+
+```http
+post /:userId
+```
+
+### Parameters
+
+```json
+{
+  "oldPassword": string,
+  "newPassword": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": UserSerializer
+}
+```
+
+see [UserSerializer](../serializer/UserSerializer.md)

user/serializer/UserSerializer.md

@@ -5,10 +5,7 @@
 ## Attributes
 
 - id : **Number** - 用户 id
-- role : **String** - 身份类型 [ STUDENT - 学生用户, TEACHER - 教师用户]
-- username : **String** - 用户名
-- nickname : **String** - 昵称
-- bio : **String **- 用户自我描述
-- avatar : **String** - 头像 URL
-- createdAt : **String** - 创建时间
-- updatedAt : **String** - 更新时间
+- role : **String** - 身份类型 `[ STUDENT - 学生用户, TEACHER - 教师用户]`
+- username : **String** - 用户名 | `[a-zA-Z0-9]{4-16}`
+- nickname : **String** - 昵称 | `[a-zA-Z0-9]{4-16}`
+- bio : **String** - 用户自我描述 | `{0-100}`