From 1d0e6896027d11f0d725e2cd7417c71359d8623a Mon Sep 17 00:00:00 2001 From: reshiner Date: Thu, 12 Aug 2021 16:53:15 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...71\347\233\256\351\234\200\346\261\202.md" | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git "a/MamaCollege/doc/2.\351\241\271\347\233\256\351\234\200\346\261\202.md" "b/MamaCollege/doc/2.\351\241\271\347\233\256\351\234\200\346\261\202.md" index 4c977cb..a230ef4 100644 --- "a/MamaCollege/doc/2.\351\241\271\347\233\256\351\234\200\346\261\202.md" +++ "b/MamaCollege/doc/2.\351\241\271\347\233\256\351\234\200\346\261\202.md" @@ -112,21 +112,21 @@ 请求地址:/user/nickname?nickname=xxx 成功返回:`{"success": true, "msg": null, "data": null}` -- 发送验证码:向指定的手机号发送验证码,将发送的验证码保存在服务端等待验证。切勿将发送的验证码值返回给前端! +- 发送验证码:向指定的手机号发送验证码,将发送的验证码保存在服务端等待验证。切勿将发送的验证码值返回给前端! 验证码为6位随机数字,有效期5分钟。 请求方式:GET 请求地址:/user/mobile/captcha?mobile=13311112222 成功返回:`{"success": true, "msg": null, "data": null}` -- 修改手机号:修改**当前登录用户**的手机号,仅当验证码正确时才进行修改,如验证码错误则返回错误信息。 +- 修改手机号:修改**当前登录用户**的手机号,仅当验证码有效且正确时才进行修改,如验证码错误或已过期,则返回错误信息。 请求方式:POST - 请求地址:/user/mobile - 请求参数:{mobile:"13312341234", captcha:"123456"} + 请求地址:/user/mobile + 请求参数:{mobile:"13312341234", captcha:"123456"} 成功返回:`{"success": true, "msg": null, "data": null}` - 修改密码:修改**当前登录用户**的登录密码,修改成功后需要结束当前会话,强制用户重新登录。仅当旧密码正确时才进行修改,如旧密码错误则返回错误信息。 请求方式:POST - 请求地址:/user/password - 请求参数:{oldPwd:"xxx", newPwd:"xxx"} + 请求地址:/user/password + 请求参数:{oldPwd:"xxx", newPwd:"xxx"} 成功返回:`{"success": true, "msg": null, "data": null}` ## 3.2 管理后台 @@ -138,13 +138,13 @@ - 上传视频:上传单个视频素材,将file存储到服务器上可通过HTTP访问的目录,再将文件HTTP访问的相对路径、视频时长(由请求参数duration指定)、原始文件名、文件大小、上传时间等信息存储到数据库。注意:要避免上传多次同名文件时已上传文件被覆盖的问题。 请求方式:POST - 请求地址:/admin/resource/video/upload - 请求参数:file=视频文件二进制流,duration=18784.23 + 请求地址:/admin/resource/video/upload + 请求参数:file=视频文件二进制流,duration=18784 成功返回:`{"success": true, "msg": null, "data": null}` - 删除资源:删除指定(由请求参数id指定)的视频资源。 请求方式:DELETE - 请求地址:/admin/resource/{id} + 请求地址:/admin/resource/{id} 成功返回:`{"success": true, "msg": null, "data": null}` ### 3.2.2 素材中心>图片 @@ -167,7 +167,7 @@ - 图片素材查询:查询所有(不分页)图片素材,按照上传时间倒序排序 请求方式:GET 请求地址:/admin/resource/image - 成功返回:http://localhost:8080/mock/admin/resource/image.json + 成功返回:http://localhost:8080/mock/admin/resource/image.json - 调整轮播图:保存轮播图数据 请求方式:POST @@ -200,7 +200,7 @@ - 课程学员分页查询:根据条件查询课程,按发布时间倒序排序,请求参数page为当前页号,size为每页数据条数 请求方式:GET - 请求地址:/admin/course/student?page=1&size=10&courseId=xxx + 请求地址:/admin/course/student?page=1&size=10&courseId=xxx 成功返回:http://localhost:8080/mock/admin/course/student.json - 修改课程:更新指定课程(由请求参数courseId指定)的信息。 @@ -217,17 +217,17 @@ - 批量添加章节:在指定课程(由请求参数courseId指定)中新增若干章节(请求体数据集合) 请求方式:POST 请求地址:/admin/course/{courseId}/addLesson - 请求参数:章节集合,数据格式为:[{name: "xxx", type: "video", duration: 10260, resource: "/xxx/xxx", resourceId: "22"}, … ] - 成功返回:`{"success": true, "msg": null, "data": null}` + 请求参数:章节集合,数据格式为:[{name: "xxx", type: "video", duration: 10260, resource: "/xxx/xxx", resourceId: "22"}, … ] + 成功返回:`{"success": true, "msg": null, "data": null}` - 修改章节:更新指定课程(由请求参数courseId指定)的指定章节(由请求参数lessonId指定)的信息。 请求方式:PUT 请求地址:/admin/course/{courseId}/lesson/{lessonId} 请求参数:{id: "1", name: "xxx", type: "video", duration: 10260, resource: "/xxx/xxx", resourceId: "22"} - 成功返回:`{"success": true, "msg": null, "data": null}` + 成功返回:`{"success": true, "msg": null, "data": null}` - 删除章节:将指定课程(由请求参数courseId指定)的指定章节(由请求参数lessonId指定)逻辑删除,注意是逻辑删除!要求逻辑删除后,所有页面不可以再看到这个章节。 - 请求方式:DELETE + 请求方式:DELETE 请求地址:/admin/course/{courseId}/lesson/{lessonId} 成功返回:`{"success": true, "msg": null, "data": null}` @@ -236,7 +236,7 @@ - 视频素材查询:查询所有(不分页)视频素材,按照上传时间倒序排序 请求方式:GET 请求地址:/admin/resource/video - 成功返回:http://localhost:8080/mock/admin/resource/video.json + 成功返回:http://localhost:8080/mock/admin/resource/video.json ## 3.3 其它需求 ### 3.3.1 课程自动过期 @@ -250,6 +250,6 @@ 系统分成了学员侧和管理后台,管理后台仅限老师访问。 # 4、部署环境 -操作系统:Centos -JDK:Oracle官方JDK 11 -数据库:MySQL \ No newline at end of file +操作系统:Centos +JDK:Oracle官方JDK 11 +数据库:MySQL \ No newline at end of file -- Gitee