update API Doc

API Doc.md

@@ -640,7 +640,7 @@ GET course_ware/course/1
      * @apiSuccess (响应结果) {Number} code
      * @apiSuccess (响应结果) {String} msg
      * @apiSuccess (响应结果) {Object} data
-     * @apiSuccess (响应结果) {Number} data.id
+     * @apiSuccess (响应结果) {Number} data.id 课件Id
      * @apiSuccess (响应结果) {Number} data.courseId
      * @apiSuccess (响应结果) {Number} data.number
      * @apiSuccess (响应结果) {String} data.title
@@ -680,6 +680,7 @@ GET course_ware/course/1
      * @apiVersion 1.0.0
      * @apiGroup CourseWareController
      * @apiName createCourseWare
+     * @apiParam (请求体) {Number} id 课件id
      * @apiParam (请求体) {Number} courseId
      * @apiParam (请求体) {Number} number 课件在本课程内的序号
      * @apiParam (请求体) {String} title
@@ -788,4 +789,128 @@ GET course_ware/course/1
                  "size": "0.01 MB"
              }
          }
-     */
+     */
+     
+     
+### CourseOrder
+
+1、 生成课程订单（可用于购买课程或赠送课程） POST course_order/create
+
+```
+    /**
+     * @api {POST} /course_order/create createCourseOrder
+     * @apiVersion 1.0.0
+     * @apiGroup CourseOrderController
+     * @apiName createCourseOrder
+     * @apiParam (请求体) {Number} cost
+     * @apiParam (请求体) {Number} courseId
+     * @apiParam (请求体) {String} courseName
+     * @apiParam (请求体) {Number} userId
+     * @apiParam (请求体) {Number} status 1 - 已支付成功； 2 - 待支付（若余额足够则直接付款，并将status转为1）； 3 - 已支付等待发货
+     * @apiParamExample 请求体示例
+         {
+             "courseId": 1,
+             "courseName": "软件工程与计算 I",
+             "cost": 1,
+             "userId": 2,
+             "status": 1
+         }
+     * @apiSuccess (响应结果) {Number} code
+     * @apiSuccess (响应结果) {String} msg
+     * @apiSuccess (响应结果) {Object} data
+     * @apiSuccess (响应结果) {Number} data.id 订单Id
+     * @apiSuccess (响应结果) {Number} data.cost
+     * @apiSuccess (响应结果) {Number} data.courseId
+     * @apiSuccess (响应结果) {String} data.courseName
+     * @apiSuccess (响应结果) {Number} data.createTime
+     * @apiSuccess (响应结果) {Number} data.userId
+     * @apiSuccess (响应结果) {Number} data.status 1 - 已支付成功； 2 - 待支付（若余额足够则直接付款，并将status转为1）； 3 - 已支付等待发货；
+     * @apiSuccessExample 响应结果示例
+         {
+             "code": 0,
+             "msg": "当前用户已经购买过此课程，或者有上一笔未支付的订单",
+             "data": {
+                 "id": 1,
+                 "cost": 1,
+                 "courseId": 1,
+                 "courseName": "软件工程与计算 I",
+                 "createTime": "2021-03-13T07:50:23.000+00:00",
+                 "userId": 2,
+                 "status": 1
+             }
+         }
+     */
+```
+
+2、 更新订单状态  POST course_order/update
+
+```
+    /**
+     * @api {POST} /course_order/update updateCourseOrderStatus
+     * @apiVersion 1.0.0
+     * @apiGroup CourseOrderController
+     * @apiName updateCourseOrderStatus
+     * @apiParam (请求参数) {Number} orderId
+     * @apiParam (请求参数) {Number} orderStatus 1 - 已支付成功（原本未支付的订单会尝试支付）； 3 - 已支付等待发货（原本未支付的订单会尝试支付）； 4 - 取消
+     * @apiParamExample 请求参数示例
+     * POST course_order/update?orderId=3&orderStatus=1
+     * @apiSuccess (响应结果) {Number} code
+     * @apiSuccess (响应结果) {String} msg
+     * @apiSuccess (响应结果) {Object} data
+     * @apiSuccess (响应结果) {Number} data.id
+     * @apiSuccess (响应结果) {Number} data.cost
+     * @apiSuccess (响应结果) {Number} data.courseId
+     * @apiSuccess (响应结果) {String} data.courseName
+     * @apiSuccess (响应结果) {Number} data.createTime
+     * @apiSuccess (响应结果) {Number} data.userId
+     * @apiSuccess (响应结果) {Number} data.status
+     * @apiSuccessExample 响应结果示例
+         {
+             "code": 1,
+             "msg": "课程购买成功",
+             "data": {
+                 "id": 3,
+                 "cost": 1,
+                 "courseId": 1,
+                 "courseName": "软件工程与计算 I",
+                 "createTime": "2021-03-13T08:08:02.000+00:00",
+                 "userId": 2,
+                 "status": 1
+             }
+         } 
+     */
+```
+
+3、 获取某用户的所有订单 GET course_order/uid/{uid} 
+
+```
+    /**
+     * @api {GET} /course_order/uid/{uid} getCourseOrders
+     * @apiVersion 1.0.0
+     * @apiGroup CourseOrderController
+     * @apiName getCourseOrders
+     * @apiParam (请求参数) {Number} uid
+     * @apiParamExample 请求参数示例
+     * GET course_order/uid/2
+     * @apiSuccess (响应结果) {Array} response
+     * @apiSuccess (响应结果) {Number} response.id
+     * @apiSuccess (响应结果) {Number} response.cost
+     * @apiSuccess (响应结果) {Number} response.courseId
+     * @apiSuccess (响应结果) {String} response.courseName
+     * @apiSuccess (响应结果) {Number} response.createTime
+     * @apiSuccess (响应结果) {Number} response.userId
+     * @apiSuccess (响应结果) {Number} response.status
+     * @apiSuccessExample 响应结果示例
+        [
+            {
+                "id": 3,
+                "cost": 1,
+                "courseId": 1,
+                "courseName": "软件工程与计算 I",
+                "createTime": "2021-03-13T08:08:02.000+00:00",
+                "userId": 2,
+                "status": 1
+            }
+        ]
+    */
+```

README.md

@@ -5,7 +5,7 @@
 #### 部分数据结构说明
 
 项目中使用了 com.github.pagehelper 分页插件，其中 PageInfo 重要的属性如下所示：
-
+```java
 public class PageInfo<T> {
     // 当前页码（无论请求中传入的页码数有多大，在返回结果中，pageNum 都是不超过总页数的）
     private int pageNum;
@@ -19,8 +19,10 @@ public class PageInfo<T> {
     private int pages;
     // 结果集
     private List<T> list;
-    ... ....
+    ...
 }
+```
+
 
 #### 文件说明