:toclevels: 3 :numbered: = Api Documentation [[_overview]] == 概览 Api Documentation === 版本信息 [%hardbreaks] __版本__ : 1.0 === 联系方式 [%hardbreaks] __名字__ : Danny Lee __邮箱__ : liqinwyyx@163.com === URI scheme [%hardbreaks] __域名__ : localhost __基础路径__ : / === 标签 * about-controller : About Controller * admin-controller : Admin Controller * comment-controller : Comment Controller * content-controller : Content Controller * course-comment-controller : Course Comment Controller * cseries-controller : Cseries Controller * cseries-notice-controller : Cseries Notice Controller * event-controller : Event Controller * forum-controller : Forum Controller * login-controller : Login Controller * ms-club-contraller : Ms Club Contraller * ms-sms-auth-controller : Ms Sms Auth Controller * ms-sys-log-controller : Ms Sys Log Controller * navigation-controller : Navigation Controller * news-controller : News Controller * permission-controller : Permission Controller * pic-upload-controller : Pic Upload Controller * ranking-classify-controller : Ranking Classify Controller * ranking-controller : Ranking Controller * reg-controller : Reg Controller * role-controller : Role Controller * search-controller : Search Controller * slide-controller : Slide Controller * ue-controller : Ue Controller * user-comment-controller : User Comment Controller * user-controller : User Controller * user-course-controller : User Course Controller * user-favourites-controller : User Favourites Controller * user-star-controller : User Star Controller * video-upload-controller : Video Upload Controller * vote-controller : Vote Controller * vote-option-controller : Vote Option Controller * we-chat-login-controller : We Chat Login Controller * 课程业务接口 : Course Controller * 课程章节单元业务接口 : Course Chapter Controller [[_paths]] == 资源 [[_about-controller_resource]] === About-controller About Controller [[_aboutlistusingget]] ==== aboutList .... GET /about/aboutList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_34dcacff9872819d750cb2de98f38141,Page«About»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /about/aboutList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "content" : "string", "createTime" : "string", "id" : 0, "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- [[_addaboutusingpost]] ==== addAbout .... POST /about/addAbout .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**content** + __可选__|内容|string |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**id** + __可选__||integer (int32) |**Query**|**updateTime** + __可选__|更新时间|string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|integer (int32) |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /about/addAbout ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- 0 ---- [[_deleteaboutusingdelete]] ==== deleteAbout .... DELETE /about/deleteAbout .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**id** + __可选__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /about/deleteAbout ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_editaboutusingput]] ==== editAbout .... PUT /about/editAbout .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**content** + __可选__|内容|string |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**id** + __可选__||integer (int32) |**Query**|**updateTime** + __可选__|更新时间|string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_about,About>> |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /about/editAbout ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "content" : "string", "createTime" : "string", "id" : 0, "updateTime" : "string" } ---- [[_toeditusingget]] ==== toEdit .... GET /about/toEdit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**id** + __可选__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /about/toEdit ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_admin-controller_resource]] === Admin-controller Admin Controller [[_addusingpost]] ==== add .... POST /admin/add .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**avatar** + __可选__|string |**Query**|**birthday** + __可选__|string (date-time) |**Query**|**certificatesId** + __可选__|string |**Query**|**city** + __可选__|string |**Query**|**clubName** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**district** + __可选__|string |**Query**|**email** + __可选__|string |**Query**|**enabled** + __可选__|integer (int32) |**Query**|**id** + __可选__|integer (int32) |**Query**|**introduction** + __可选__|string |**Query**|**isLive** + __可选__|integer (int32) |**Query**|**jwtToken** + __可选__|string |**Query**|**lastLoginIp** + __可选__|string |**Query**|**lastLoginTime** + __可选__|string (date-time) |**Query**|**logo** + __可选__|string |**Query**|**managerName** + __可选__|string |**Query**|**mobile** + __可选__|string |**Query**|**openId** + __可选__|string |**Query**|**password** + __可选__|string |**Query**|**passwordHash** + __可选__|string (byte) |**Query**|**passwordSalt** + __可选__|string (byte) |**Query**|**post** + __可选__|string |**Query**|**province** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**registIp** + __可选__|string |**Query**|**registTime** + __可选__|string (date-time) |**Query**|**roleId** + __可选__|integer (int32) |**Query**|**sex** + __可选__|integer (int32) |**Query**|**totalLoginCounts** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**userType** + __可选__|integer (int32) |**Query**|**username** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/add ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_batchdelusingdelete]] ==== batchDel .... DELETE /admin/batchDel .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**adminIds** + __可选__|adminIds|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/batchDel ---- [[_deleteusingdelete]] ==== delete .... DELETE /admin/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**adminId** + __可选__|adminId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/delete ---- [[_editusingput]] ==== edit .... PUT /admin/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**avatar** + __可选__|string |**Query**|**birthday** + __可选__|string (date-time) |**Query**|**certificatesId** + __可选__|string |**Query**|**city** + __可选__|string |**Query**|**clubName** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**district** + __可选__|string |**Query**|**email** + __可选__|string |**Query**|**enabled** + __可选__|integer (int32) |**Query**|**id** + __可选__|integer (int32) |**Query**|**introduction** + __可选__|string |**Query**|**isLive** + __可选__|integer (int32) |**Query**|**jwtToken** + __可选__|string |**Query**|**lastLoginIp** + __可选__|string |**Query**|**lastLoginTime** + __可选__|string (date-time) |**Query**|**logo** + __可选__|string |**Query**|**managerName** + __可选__|string |**Query**|**mobile** + __可选__|string |**Query**|**openId** + __可选__|string |**Query**|**password** + __可选__|string |**Query**|**passwordHash** + __可选__|string (byte) |**Query**|**passwordSalt** + __可选__|string (byte) |**Query**|**post** + __可选__|string |**Query**|**province** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**registIp** + __可选__|string |**Query**|**registTime** + __可选__|string (date-time) |**Query**|**roleId** + __可选__|integer (int32) |**Query**|**sex** + __可选__|integer (int32) |**Query**|**totalLoginCounts** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**userType** + __可选__|integer (int32) |**Query**|**username** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/edit ---- [[_editinfousingput]] ==== editInfo .... PUT /admin/editInfo .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**password** + __必填__|password|string |**Query**|**realname** + __必填__|realname|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/editInfo?password=string&realname=string ---- [[_editpwdusingput]] ==== editPwd .... PUT /admin/editPwd .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**oldPassWord** + __必填__|oldPassWord|string |**Query**|**password** + __必填__|password|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/editPwd?oldPassWord=string&password=string ---- [[_enableusingput]] ==== enable .... PUT /admin/enable .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**adminId** + __可选__|adminId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/enable ---- [[_getadminlistusingget]] ==== getAdminList .... GET /admin/getAdminList .... ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_e74dd976185b63fab3d0c002ca14d581,Page«User»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /admin/getAdminList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "authCacheKey" : "string", "avatar" : "string", "birthday" : "string", "certificatesId" : "string", "city" : "string", "clubName" : "string", "createTime" : "string", "district" : "string", "email" : "string", "enabled" : 0, "id" : 0, "introduction" : "string", "isLive" : 0, "jwtToken" : "string", "lastLoginIp" : "string", "lastLoginTime" : "string", "logo" : "string", "managerName" : "string", "mobile" : "string", "openId" : "string", "password" : "string", "passwordHash" : "string", "passwordSalt" : "string", "post" : "string", "province" : "string", "realname" : "string", "registIp" : "string", "registTime" : "string", "roleId" : 0, "sex" : 0, "totalLoginCounts" : 0, "updateTime" : "string", "userType" : 0, "username" : "string" } ], "size" : 0, "total" : 0 } ---- [[_comment-controller_resource]] === Comment-controller Comment Controller [[_allhadreadusingpost]] ==== allHadRead .... POST /comment/allHadRead .... ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /comment/allHadRead ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deleteusingdelete_1]] ==== 递归删除评论 .... DELETE /comment/delete .... ===== 说明 根据commentId递归删除评论及子评论 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**commentId** + __可选__|评论ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /comment/delete ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_findusingget]] ==== find .... GET /comment/get/{id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**id** + __必填__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_comment,Comment>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /comment/get/0 ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "childrenCount" : 0, "content" : "string", "contentId" : 0, "createTime" : "string", "forumId" : 0, "id" : 0, "mentionedComment" : "string", "parentId" : 0, "stars" : 0, "timeRange" : "string", "updateTime" : "string", "userId" : 0 } ---- [[_getcommentlistusingget]] ==== 根据根据contentId查询评论分页列表 .... GET /comment/getCommentList .... ===== 说明 根据根据contentId查询评论分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**childrenCount** + __可选__|子评论数量|integer (int32) |**Query**|**content** + __可选__|评论内容|string |**Query**|**contentId** + __必填__|所属内容|string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**forumId** + __可选__|所属板块|integer (int32) |**Query**|**id** + __可选__||integer (int32) |**Query**|**mentionedComment** + __可选__||string |**Query**|**parentId** + __可选__|父评论id|integer (int32) |**Query**|**stars** + __可选__|点赞量|integer (int32) |**Query**|**timeRange** + __可选__||string |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**userId** + __可选__|评论人ID|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_052e9a21b4156f3087f25bdae679f2ea,Page«Comment»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /comment/getCommentList?contentId=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "childrenCount" : 0, "content" : "string", "contentId" : 0, "createTime" : "string", "forumId" : 0, "id" : 0, "mentionedComment" : "string", "parentId" : 0, "stars" : 0, "timeRange" : "string", "updateTime" : "string", "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_getcontentpagelistusingget]] ==== 查询评论管理分页列表 .... GET /comment/getContentPageList .... ===== 说明 查询评论管理分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**atTop** + __可选__|是否置顶 true:1 false:0|boolean |**Query**|**banner** + __可选__|内容头图|string |**Query**|**clicks** + __可选__|点击量|integer (int32) |**Query**|**commentCount** + __可选__|评论数量|integer (int32) |**Query**|**content** + __可选__|内容|string |**Query**|**contentType** + __可选__|内容类型|integer (int32) |**Query**|**cover** + __可选__|列表中展示图片|string |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**entity.user.username** + __可选__|评论人的用户名|string |**Query**|**favourites** + __可选__|收藏量|integer (int32) |**Query**|**forumId** + __可选__|板块id|ref |**Query**|**forwardingCount** + __可选__|转发量|integer (int32) |**Query**|**hasRead** + __可选__|已读 true:1 false:0|boolean |**Query**|**hasVote** + __可选__|是否插入投票 true:1 false:0|integer (int32) |**Query**|**id** + __可选__|内容id|integer (int32) |**Query**|**sources** + __可选__|来源|string |**Query**|**stars** + __可选__|点赞量|integer (int32) |**Query**|**styleId** + __可选__|背景风格id|integer (int32) |**Query**|**subtitle** + __可选__|子标题|string |**Query**|**thumbnail** + __可选__|缩略图|string |**Query**|**timeRange** + __可选__||string |**Query**|**title** + __可选__|内容表题|string |**Query**|**updateTime** + __可选__|更新时间|string (date-time) |**Query**|**videoUrl** + __可选__|视频链接|string |**Query**|**voteId** + __可选__||integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_17ff3e2cd73f8dc03e4694de7a1250a4,Page«Content»>> |=== ===== 生成 * `\*/*` * `application/json` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /comment/getContentPageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "atTop" : true, "banner" : "string", "clicks" : 0, "commentCount" : 0, "content" : "string", "contentType" : 0, "cover" : "string", "createTime" : "string", "favourites" : 0, "forumId" : 0, "forwardingCount" : 0, "hasRead" : true, "hasVote" : 0, "id" : 0, "sources" : "string", "stars" : 0, "styleId" : 0, "subtitle" : "string", "thumbnail" : "string", "timeRange" : "string", "title" : "string", "updateTime" : "string", "videoUrl" : "string", "voteId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_saveusingpost]] ==== 内容评论和回复评论 .... POST /comment/save .... ===== 说明 根据contentId和userId以及评论内容实现内容评论和回复评论 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**childrenCount** + __可选__|子评论数量|integer (int32) |**Query**|**content** + __可选__|评论内容|ref |**Query**|**contentId** + __可选__|内容id|ref |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**forumId** + __可选__|所属板块|integer (int32) |**Query**|**id** + __可选__||integer (int32) |**Query**|**mentionedComment** + __可选__||string |**Query**|**parentId** + __可选__|父评论id|ref |**Query**|**stars** + __可选__|点赞量|integer (int32) |**Query**|**timeRange** + __可选__||string |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**userId** + __可选__|用户id|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /comment/save ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_content-controller_resource]] === Content-controller Content Controller [[_deletecontentbyidusingdelete]] ==== deleteContentById .... DELETE /content/deleteContentById .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentId** + __可选__|contentId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /content/deleteContentById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deletecontentsusingdelete]] ==== deleteContents .... DELETE /content/deleteContents .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentIds** + __可选__|contentIds|< string > array(multi) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /content/deleteContents ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_editcontentusingpost]] ==== editContent .... POST /content/editContent .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**atTop** + __可选__|是否置顶 true:1 false:0|boolean |**Query**|**banner** + __可选__|内容头图|string |**Query**|**clicks** + __可选__|点击量|integer (int32) |**Query**|**commentCount** + __可选__|评论数量|integer (int32) |**Query**|**content** + __可选__|内容|string |**Query**|**contentType** + __可选__|内容类型|integer (int32) |**Query**|**cover** + __可选__|列表中展示图片|string |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**favourites** + __可选__|收藏量|integer (int32) |**Query**|**forumId** + __可选__|板块id|integer (int32) |**Query**|**forwardingCount** + __可选__|转发量|integer (int32) |**Query**|**hasRead** + __可选__|已读 true:1 false:0|boolean |**Query**|**hasVote** + __可选__|是否插入投票 true:1 false:0|integer (int32) |**Query**|**id** + __可选__|内容id|integer (int32) |**Query**|**sources** + __可选__|来源|string |**Query**|**stars** + __可选__|点赞量|integer (int32) |**Query**|**styleId** + __可选__|背景风格id|integer (int32) |**Query**|**subtitle** + __可选__|子标题|string |**Query**|**thumbnail** + __可选__|缩略图|string |**Query**|**timeRange** + __可选__||string |**Query**|**title** + __可选__|内容表题|string |**Query**|**updateTime** + __可选__|更新时间|string (date-time) |**Query**|**videoUrl** + __可选__|视频链接|string |**Query**|**voteId** + __可选__||integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /content/editContent ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_findcontentbyidusingget]] ==== 后台使用---查询板块详情 .... GET /content/findContentById .... ===== 说明 查询板块详情 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentId** + __可选__|contentId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /content/findContentById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_findfrontcontentbyidusingget]] ==== 前台点击---查询板块详情 .... GET /content/findFrontContentById .... ===== 说明 查询板块详情 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentId** + __可选__|contentId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /content/findFrontContentById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getforumlistusingget]] ==== getForumList .... GET /content/getContentList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**clicksSort** + __可选__|clicksSort|string |**Query**|**contentName** + __可选__|contentName|string |**Query**|**favouritesSort** + __可选__|favouritesSort|string |**Query**|**forumId** + __可选__|forumId|string |**Query**|**forwardSort** + __可选__|forwardSort|string |**Query**|**starsSort** + __可选__|starsSort|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_17ff3e2cd73f8dc03e4694de7a1250a4,Page«Content»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /content/getContentList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "atTop" : true, "banner" : "string", "clicks" : 0, "commentCount" : 0, "content" : "string", "contentType" : 0, "cover" : "string", "createTime" : "string", "favourites" : 0, "forumId" : 0, "forwardingCount" : 0, "hasRead" : true, "hasVote" : 0, "id" : 0, "sources" : "string", "stars" : 0, "styleId" : 0, "subtitle" : "string", "thumbnail" : "string", "timeRange" : "string", "title" : "string", "updateTime" : "string", "videoUrl" : "string", "voteId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_toaddcontentusingget]] ==== toAddContent .... GET /content/toAddContent .... ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /content/toAddContent ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_course-comment-controller_resource]] === Course-comment-controller Course Comment Controller [[_deleteusingdelete_3]] ==== 递归删除课程评论 .... DELETE /courseComment/delete .... ===== 说明 根据courseCommentId递归删除课程评论及子课程评论 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**courseCommentId** + __可选__|课程评论ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseComment/delete ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_findusingget_2]] ==== find .... GET /courseComment/get/{id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**id** + __必填__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_coursecomment,CourseComment>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseComment/get/0 ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "childrenCount" : 0, "content" : "string", "courseId" : 0, "createTime" : "string", "cseriesId" : 0, "id" : 0, "mentionedCourseComment" : "string", "parentId" : 0, "stars" : 0, "timeRange" : "string", "updateTime" : "string", "userId" : 0 } ---- [[_getcoursecommentlistusingget]] ==== 根据根据courseId查询课程评论分页列表 .... GET /courseComment/getCourseCommentList .... ===== 说明 根据根据courseId查询课程评论分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**childrenCount** + __可选__||integer (int32) |**Query**|**content** + __可选__||string |**Query**|**courseId** + __必填__|所属内容|string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**cseriesId** + __可选__||integer (int32) |**Query**|**id** + __可选__||integer (int32) |**Query**|**mentionedCourseComment** + __可选__||string |**Query**|**parentId** + __可选__||integer (int32) |**Query**|**stars** + __可选__||integer (int32) |**Query**|**timeRange** + __可选__||string |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**userId** + __可选__||integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_02278037ab4d834a188ebd132462e29f,Page«CourseComment»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseComment/getCourseCommentList?courseId=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "childrenCount" : 0, "content" : "string", "courseId" : 0, "createTime" : "string", "cseriesId" : 0, "id" : 0, "mentionedCourseComment" : "string", "parentId" : 0, "stars" : 0, "timeRange" : "string", "updateTime" : "string", "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_getcoursepagelistusingget]] ==== 查询课程评论管理分页列表 .... GET /courseComment/getCoursePageList .... ===== 说明 查询课程评论管理分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**childrenCount** + __可选__||integer (int32) |**Query**|**content** + __可选__||string |**Query**|**courseId** + __可选__||integer (int32) |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**cseriesId** + __可选__||integer (int32) |**Query**|**entity.user.username** + __可选__|课程评论人的用户名|string |**Query**|**id** + __可选__||integer (int32) |**Query**|**mentionedCourseComment** + __可选__||string |**Query**|**parentId** + __可选__||integer (int32) |**Query**|**stars** + __可选__||integer (int32) |**Query**|**timeRange** + __可选__||string |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**userId** + __可选__||integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_02278037ab4d834a188ebd132462e29f,Page«CourseComment»>> |=== ===== 生成 * `\*/*` * `application/json` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseComment/getCoursePageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "childrenCount" : 0, "content" : "string", "courseId" : 0, "createTime" : "string", "cseriesId" : 0, "id" : 0, "mentionedCourseComment" : "string", "parentId" : 0, "stars" : 0, "timeRange" : "string", "updateTime" : "string", "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_saveusingpost_2]] ==== 内容课程评论和回复课程评论 .... POST /courseComment/save .... ===== 说明 根据courseId和userId以及课程评论内容实现内容课程评论和回复课程评论 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Header**|**Authorization** + __必填__|Authorization|string |**Query**|**childrenCount** + __可选__||integer (int32) |**Query**|**content** + __可选__|课程评论内容|ref |**Query**|**courseId** + __可选__|课程id|ref |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**cseriesId** + __可选__||integer (int32) |**Query**|**id** + __可选__||integer (int32) |**Query**|**mentionedCourseComment** + __可选__||string |**Query**|**parentId** + __可选__|父课程评论id|ref |**Query**|**stars** + __可选__||integer (int32) |**Query**|**timeRange** + __可选__||string |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**userId** + __可选__|用户id|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseComment/save ---- ====== 请求 header [source,json] ---- "string" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_cseries-controller_resource]] === Cseries-controller Cseries Controller [[_addusingpost_2]] ==== 添加课程系列 .... POST /cseries/add .... ===== 说明 添加课程系列 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**background** + __可选__|课程系列背景图|string |**Query**|**courseAmont** + __可选__|课程数量|integer (int32) |**Query**|**id** + __可选__|课程系列ID|integer (int32) |**Query**|**logo** + __可选__|课程系列LOGO|string |**Query**|**name** + __可选__|课程系列名称|string |**FormData**|**cover** + __可选__|LOGO|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseries/add ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deletecseriesusingdelete]] ==== 删除课程系列 .... DELETE /cseries/delete .... ===== 说明 删除课程系列 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**cseriesId** + __可选__|课程系列ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseries/delete ---- [[_editusingput_3]] ==== edit .... PUT /cseries/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**background** + __可选__|课程系列背景图|string |**Query**|**courseAmont** + __可选__|课程数量|integer (int32) |**Query**|**id** + __可选__|课程系列ID|integer (int32) |**Query**|**logo** + __可选__|课程系列LOGO|string |**Query**|**name** + __可选__|课程系列名称|string |**FormData**|**cover** + __可选__|LOGO|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseries/edit ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getusingget_1]] ==== 查询单个课程系列 .... GET /cseries/get/{cseriesId} .... ===== 说明 查询单个课程系列 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**cseriesId** + __可选__|课程系列ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_4a9df568c3f33166a1d37ab929a40fc3,课程系列>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseries/get/ref ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "background" : "string", "courseAmont" : 0, "id" : 0, "logo" : "string", "name" : "string" } ---- [[_getcseriespagelistusingget]] ==== 查询课程系列分页列表 .... GET /cseries/getCseriesPageList .... ===== 说明 查询课程系列分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_805ef2039d8b2bf4abf1c68ce2cccb84,Page«课程系列»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseries/getCseriesPageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "background" : "string", "courseAmont" : 0, "id" : 0, "logo" : "string", "name" : "string" } ], "size" : 0, "total" : 0 } ---- [[_cseries-notice-controller_resource]] === Cseries-notice-controller Cseries Notice Controller [[_addusingpost_3]] ==== 添加课程系列公告 .... POST /cseriesNotice/add .... ===== 说明 添加课程系列公告 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**content** + __可选__|课程公告内容|string |**Query**|**cover** + __可选__|课程公告封面图|string |**Query**|**cseriesId** + __可选__|课程系列ID|integer (int32) |**Query**|**id** + __可选__|课程公告ID|integer (int32) |**Query**|**title** + __可选__|课程公告标题|string |**FormData**|**banner** + __可选__|LOGO|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseriesNotice/add ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deletecseriesnoticeusingdelete]] ==== 删除课程系列公告 .... DELETE /cseriesNotice/delete .... ===== 说明 删除课程系列公告 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**cseriesNoticeId** + __可选__|课程系列公告ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseriesNotice/delete ---- [[_editusingput_4]] ==== edit .... PUT /cseriesNotice/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**content** + __可选__|课程公告内容|string |**Query**|**cover** + __可选__|课程公告封面图|string |**Query**|**cseriesId** + __可选__|课程系列ID|integer (int32) |**Query**|**id** + __可选__|课程公告ID|integer (int32) |**Query**|**title** + __可选__|课程公告标题|string |**FormData**|**banner** + __可选__|封面图|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseriesNotice/edit ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getbyidusingget]] ==== getById .... GET /cseriesNotice/get/{id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**cseriesNoticeId** + __必填__|cseriesNoticeId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_c579e2d002cf09f3922fca8d061f9400,课程公告>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseriesNotice/get/{id} ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "content" : "string", "cover" : "string", "cseriesId" : 0, "id" : 0, "title" : "string" } ---- [[_getcseriesnoticepagelistusingget]] ==== 查询课程系列公告分页列表 .... GET /cseriesNotice/getCseriesNoticePageList .... ===== 说明 查询课程系列公告分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**cseriesId** + __可选__|课程系列ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_3f99111dc5e4b2b3863260fc6ec717e3,Page«课程公告»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /cseriesNotice/getCseriesNoticePageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "content" : "string", "cover" : "string", "cseriesId" : 0, "id" : 0, "title" : "string" } ], "size" : 0, "total" : 0 } ---- [[_event-controller_resource]] === Event-controller Event Controller [[_addeventusingpost]] ==== addEvent .... POST /event/addEvent .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**city** + __可选__|比赛地点 城市 例：1北京|string |**Query**|**content** + __可选__|编辑器内容|string |**Query**|**country** + __可选__|比赛地点 国家 例：0中国|string |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**endTime** + __可选__|结束时间|string (date-time) |**Query**|**event** + __可选__|是否展示倒计时事件 1:true 0:false|boolean |**Query**|**headMap** + __可选__|头图|string |**Query**|**id** + __可选__|事件ID|integer (int32) |**Query**|**linkAddress** + __可选__|链接地址|string |**Query**|**logo** + __可选__|系列赛logo|string |**Query**|**logoName** + __可选__|系列赛名称|string |**Query**|**match** + __可选__|是否为重点赛事 1：true 0:false|boolean |**Query**|**nationalFlag** + __可选__|国旗|string |**Query**|**startTime** + __可选__|开始时间|string (date-time) |**Query**|**title** + __可选__|事件标题|string |**Query**|**type** + __可选__|比赛类型|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /event/addEvent ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deleteeventusingdelete]] ==== deleteEvent .... DELETE /event/deleteEvent .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**id** + __可选__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /event/deleteEvent ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_editeventusingput]] ==== editEvent .... PUT /event/editEvent .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**city** + __可选__|比赛地点 城市 例：1北京|string |**Query**|**content** + __可选__|编辑器内容|string |**Query**|**country** + __可选__|比赛地点 国家 例：0中国|string |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**endTime** + __可选__|结束时间|string (date-time) |**Query**|**event** + __可选__|是否展示倒计时事件 1:true 0:false|boolean |**Query**|**headMap** + __可选__|头图|string |**Query**|**id** + __可选__|事件ID|integer (int32) |**Query**|**linkAddress** + __可选__|链接地址|string |**Query**|**logo** + __可选__|系列赛logo|string |**Query**|**logoName** + __可选__|系列赛名称|string |**Query**|**match** + __可选__|是否为重点赛事 1：true 0:false|boolean |**Query**|**nationalFlag** + __可选__|国旗|string |**Query**|**startTime** + __可选__|开始时间|string (date-time) |**Query**|**title** + __可选__|事件标题|string |**Query**|**type** + __可选__|比赛类型|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /event/editEvent ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_eventlistusingget]] ==== eventList .... GET /event/eventList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**country** + __可选__|country|string |**Query**|**isEvent** + __可选__|isEvent|string |**Query**|**logoName** + __可选__|logoName|string |**Query**|**match** + __可选__|match|string |**Query**|**month** + __可选__|month|string |**Query**|**startTime** + __可选__|startTime|string |**Query**|**title** + __可选__|title|string |**Query**|**type** + __可选__|type|string |**Query**|**year** + __可选__|year|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_f8833f942faff206036106eeedb317ed,Page«Event»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /event/eventList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "city" : "string", "content" : "string", "country" : "string", "createTime" : "string", "endTime" : "string", "event" : true, "headMap" : "string", "id" : 0, "linkAddress" : "string", "logo" : "string", "logoName" : "string", "match" : true, "nationalFlag" : "string", "startTime" : "string", "title" : "string", "type" : "string" } ], "size" : 0, "total" : 0 } ---- [[_toeditusingget_1]] ==== toEdit .... GET /event/toEdit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**id** + __可选__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /event/toEdit ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_forum-controller_resource]] === Forum-controller Forum Controller [[_deleteforumbyidusingdelete]] ==== deleteForumById .... DELETE /forum/deleteForumById .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**forumId** + __可选__|forumId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /forum/deleteForumById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_editforumusingpost]] ==== editForum .... POST /forum/editForum .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**banner** + __可选__|板块头图|string |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**id** + __可选__||integer (int32) |**Query**|**logo** + __可选__|板块列表中的图|string |**Query**|**name** + __可选__|板块名称|string |**Query**|**parentId** + __可选__|父级id|integer (int32) |**Query**|**sortorder** + __可选__|排序|integer (int32) |**Query**|**summary** + __可选__|摘要|string |**Query**|**updateTime** + __可选__|更新时间|string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /forum/editForum ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_findforumbyidusingget]] ==== 查询板块详情 .... GET /forum/findForumById .... ===== 说明 查询板块详情 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**forumId** + __可选__|forumId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /forum/findForumById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getforumlistusingget_1]] ==== 板块列表 .... GET /forum/getForumList .... ===== 说明 板块列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_d2128bca6950112f6d84c39fc770dbe4,Page«Forum»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /forum/getForumList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "banner" : "string", "createTime" : "string", "id" : 0, "logo" : "string", "name" : "string", "parentId" : 0, "sortorder" : 0, "summary" : "string", "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- [[_toaddusingget]] ==== toAdd .... GET /forum/toAdd .... ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /forum/toAdd ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_updatesortorderusingput_1]] ==== updateSortorder .... PUT /forum/updateSortorder .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**moveType** + __可选__|moveType|string |**Query**|**sourceId** + __可选__|sourceId|integer (int32) |**Query**|**targetId** + __可选__|targetId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /forum/updateSortorder ---- [[_updatesortorderbyonestepusingput]] ==== updateSortorderByOneStep .... PUT /forum/updateSortorderByOneStep .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**firstId** + __可选__|firstId|integer (int32) |**Query**|**secondId** + __可选__|secondId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /forum/updateSortorderByOneStep ---- [[_login-controller_resource]] === Login-controller Login Controller [[_ajaxloginusingpost]] ==== ajaxLogin .... POST /ajaxLogin .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**password** + __必填__|password|string |**Query**|**username** + __必填__|username|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ajaxLogin?password=string&username=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_culbajaxloginusingpost]] ==== culbAjaxLogin .... POST /culbAjaxLogin .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**mobile** + __必填__|mobile|string |**Query**|**password** + __必填__|password|string |**Query**|**rememberMe** + __必填__|rememberMe|boolean |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /culbAjaxLogin?mobile=string&password=string&rememberMe=true ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getgifcodeusingget]] ==== getGifCode .... GET /getGifCode/{username} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**username** + __必填__|username|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /getGifCode/string ---- [[_logoutusingget]] ==== logout .... GET /logout .... ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /logout ---- [[_mobileloginusingpost]] ==== mobileLogin .... POST /mobileLogin .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**mobile** + __必填__|mobile|string |**Query**|**rememberMe** + __必填__|rememberMe|boolean |**Query**|**smsCode** + __必填__|smsCode|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /mobileLogin?mobile=string&rememberMe=true&smsCode=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_sendsmsauthousingget]] ==== sendSmsAutho .... GET /sendSmsAutho .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**phoneNum** + __必填__|phoneNum|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /sendSmsAutho?phoneNum=string ---- [[_sendupdatapassusingget]] ==== sendUpdataPass .... GET /sendUpdataPass .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**phone** + __必填__|phone|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|string |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /sendUpdataPass?phone=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "string" ---- [[_ms-club-contraller_resource]] === Ms-club-contraller Ms Club Contraller [[_deleteuserusingdelete]] ==== deleteUser .... DELETE /msclub/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**clubId** + __可选__|clubId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|integer (int32) |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msclub/delete ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- 0 ---- [[_editusingput_5]] ==== edit .... PUT /msclub/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**avatar** + __可选__|string |**Query**|**birthday** + __可选__|string (date-time) |**Query**|**certificatesId** + __可选__|string |**Query**|**city** + __可选__|string |**Query**|**clubName** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**district** + __可选__|string |**Query**|**email** + __可选__|string |**Query**|**enabled** + __可选__|integer (int32) |**Query**|**id** + __可选__|integer (int32) |**Query**|**introduction** + __可选__|string |**Query**|**isLive** + __可选__|integer (int32) |**Query**|**jwtToken** + __可选__|string |**Query**|**lastLoginIp** + __可选__|string |**Query**|**lastLoginTime** + __可选__|string (date-time) |**Query**|**logo** + __可选__|string |**Query**|**managerName** + __可选__|string |**Query**|**mobile** + __可选__|string |**Query**|**openId** + __可选__|string |**Query**|**password** + __可选__|string |**Query**|**passwordHash** + __可选__|string (byte) |**Query**|**passwordSalt** + __可选__|string (byte) |**Query**|**post** + __可选__|string |**Query**|**province** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**registIp** + __可选__|string |**Query**|**registTime** + __可选__|string (date-time) |**Query**|**roleId** + __可选__|integer (int32) |**Query**|**sex** + __可选__|integer (int32) |**Query**|**totalLoginCounts** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**userType** + __可选__|integer (int32) |**Query**|**username** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msclub/edit ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_queryuserlistusingget]] ==== queryUserList .... GET /msclub/getClubList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**clubName** + __可选__|clubName|string |**Query**|**paramAlias** + __可选__||string |**Query**|**paramNameValuePairs** + __可选__||object |**Query**|**sqlSelect** + __可选__||string |**Query**|**userType** + __可选__|userType|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_e74dd976185b63fab3d0c002ca14d581,Page«User»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msclub/getClubList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "authCacheKey" : "string", "avatar" : "string", "birthday" : "string", "certificatesId" : "string", "city" : "string", "clubName" : "string", "createTime" : "string", "district" : "string", "email" : "string", "enabled" : 0, "id" : 0, "introduction" : "string", "isLive" : 0, "jwtToken" : "string", "lastLoginIp" : "string", "lastLoginTime" : "string", "logo" : "string", "managerName" : "string", "mobile" : "string", "openId" : "string", "password" : "string", "passwordHash" : "string", "passwordSalt" : "string", "post" : "string", "province" : "string", "realname" : "string", "registIp" : "string", "registTime" : "string", "roleId" : 0, "sex" : 0, "totalLoginCounts" : 0, "updateTime" : "string", "userType" : 0, "username" : "string" } ], "size" : 0, "total" : 0 } ---- [[_ms-sms-auth-controller_resource]] === Ms-sms-auth-controller Ms Sms Auth Controller [[_editpageusingget]] ==== editPage .... GET /msSmsAuth/editPage/{Id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**Id** + __必填__|Id|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_mssmsauth,MsSmsAuth>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msSmsAuth/editPage/string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "code" : "string", "createTime" : "string", "id" : 0, "iphone" : "string", "remark" : "string", "type" : "string" } ---- [[_queryloglistusingget]] ==== queryLogList .... GET /msSmsAuth/getLogList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**paramAlias** + __可选__|string |**Query**|**paramNameValuePairs** + __可选__|object |**Query**|**sqlSelect** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_8b78d64bed117e8c4c50c4d6edc76544,Page«MsSmsAuth»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msSmsAuth/getLogList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "code" : "string", "createTime" : "string", "id" : 0, "iphone" : "string", "remark" : "string", "type" : "string" } ], "size" : 0, "total" : 0 } ---- [[_ms-sys-log-controller_resource]] === Ms-sys-log-controller Ms Sys Log Controller [[_addusingpost_4]] ==== add .... POST /msSysLog/add .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**content** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**id** + __可选__|integer (int32) |**Query**|**ip** + __可选__|string |**Query**|**loginName** + __可选__|string |**Query**|**operation** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_mssyslog,MsSysLog>> |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msSysLog/add ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "content" : "string", "createTime" : "string", "id" : 0, "ip" : "string", "loginName" : "string", "operation" : "string" } ---- [[_deleteaboutusingdelete_1]] ==== deleteAbout .... DELETE /msSysLog/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**logId** + __可选__|logId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msSysLog/delete ---- [[_queryloglistusingget_1]] ==== queryLogList .... GET /msSysLog/getLogList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**endTime** + __可选__|endTime|string |**Query**|**loginName** + __可选__|loginName|string |**Query**|**paramAlias** + __可选__||string |**Query**|**paramNameValuePairs** + __可选__||object |**Query**|**sqlSelect** + __可选__||string |**Query**|**startTime** + __可选__|startTime|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_d626f0b9145010a8973821b1d3aeccfa,Page«MsSysLog»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msSysLog/getLogList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "content" : "string", "createTime" : "string", "id" : 0, "ip" : "string", "loginName" : "string", "operation" : "string" } ], "size" : 0, "total" : 0 } ---- [[_getlogusingget]] ==== 查看系统日志情况 .... GET /msSysLog/getMsSysLog .... ===== 说明 查看系统日志情况 ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**paramAlias** + __可选__|string |**Query**|**paramNameValuePairs** + __可选__|object |**Query**|**sqlSelect** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_mssyslog,MsSysLog>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /msSysLog/getMsSysLog ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "content" : "string", "createTime" : "string", "id" : 0, "ip" : "string", "loginName" : "string", "operation" : "string" } ---- [[_navigation-controller_resource]] === Navigation-controller Navigation Controller [[_addusingpost_5]] ==== add .... POST /navigation/add .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**id** + __可选__|Herder管理ID|integer (int32) |**Query**|**link** + __可选__|超链接|string |**Query**|**logo** + __可选__|图片|string |**Query**|**navType** + __可选__|是顶部还是底部，1是顶部0是底部|ref |**Query**|**sortorder** + __可选__|排序方式|integer (int32) |**Query**|**title** + __可选__|标题|string |**Query**|**updateTime** + __可选__|更新时间|string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /navigation/add ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deleteheaderusingdelete]] ==== deleteHeader .... DELETE /navigation/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**navigationId** + __必填__|navigationId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /navigation/delete?navigationId=0 ---- [[_editusingput_6]] ==== edit .... PUT /navigation/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**createTime** + __可选__|创建时间|string (date-time) |**Query**|**id** + __可选__|Herder管理ID|integer (int32) |**Query**|**link** + __可选__|超链接|string |**Query**|**logo** + __可选__|图片|string |**Query**|**navType** + __可选__||integer (int32) |**Query**|**sortorder** + __可选__|排序方式|integer (int32) |**Query**|**title** + __可选__|标题|string |**Query**|**updateTime** + __可选__|更新时间|string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /navigation/edit ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getheaderusingget]] ==== getHeader .... GET /navigation/get/{id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**id** + __必填__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_navigation,Navigation>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /navigation/get/0 ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "createTime" : "string", "id" : 0, "link" : "string", "logo" : "string", "navType" : 0, "sortorder" : 0, "title" : "string", "updateTime" : "string" } ---- [[_getheaderlistusingget]] ==== getHeaderList .... GET /navigation/getHeaderList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**navType** + __可选__|数据类型|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_767dfddd4ae8b55c1bb050ae9b91b73b,Page«Navigation»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /navigation/getHeaderList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "createTime" : "string", "id" : 0, "link" : "string", "logo" : "string", "navType" : 0, "sortorder" : 0, "title" : "string", "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- [[_news-controller_resource]] === News-controller News Controller [[_batchdelusingdelete_1]] ==== batchDel .... DELETE /news/batchDel .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**newsIds** + __可选__|newsIds|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/batchDel ---- [[_checkusingpost]] ==== check .... POST /news/check .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**approved** + __可选__|integer (int32) |**Query**|**author** + __可选__|string |**Query**|**channelId** + __可选__|string |**Query**|**clicks** + __可选__|integer (int32) |**Query**|**commentCount** + __可选__|integer (int32) |**Query**|**commentsNum** + __可选__|integer (int32) |**Query**|**content** + __可选__|string |**Query**|**cover** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**endTime** + __可选__|string (date-time) |**Query**|**favorite** + __可选__|boolean |**Query**|**id** + __可选__|integer (int32) |**Query**|**newsSource** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**signUpNum** + __可选__|integer (int32) |**Query**|**signUpTotlNum** + __可选__|integer (int32) |**Query**|**slidesId** + __可选__|integer (int32) |**Query**|**startTime** + __可选__|string (date-time) |**Query**|**tag** + __可选__|string |**Query**|**thumbnail** + __可选__|string |**Query**|**thumbsUp** + __可选__|integer (int32) |**Query**|**title** + __可选__|string |**Query**|**type** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**videoType** + __可选__|integer (int32) |**Query**|**videoUrl** + __可选__|string |**Query**|**videostateId** + __可选__|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|integer (int32) |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/check ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- 0 ---- [[_deletenewsusingdelete]] ==== deleteNews .... DELETE /news/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**newsId** + __可选__|newsId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|integer (int32) |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/delete ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- 0 ---- [[_editusingpost]] ==== edit .... POST /news/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**approved** + __可选__||integer (int32) |**Query**|**author** + __可选__||string |**Query**|**channelId** + __可选__||string |**Query**|**channelIdFirst** + __可选__|channelIdFirst|string |**Query**|**channelIdSecond** + __可选__|channelIdSecond|string |**Query**|**channelIdThird** + __可选__|channelIdThird|string |**Query**|**clicks** + __可选__||integer (int32) |**Query**|**commentCount** + __可选__||integer (int32) |**Query**|**commentsNum** + __可选__||integer (int32) |**Query**|**content** + __可选__||string |**Query**|**cover** + __可选__||string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**endTime** + __可选__||string (date-time) |**Query**|**favorite** + __可选__||boolean |**Query**|**id** + __可选__||integer (int32) |**Query**|**newsSource** + __可选__||string |**Query**|**realname** + __可选__||string |**Query**|**signUpNum** + __可选__||integer (int32) |**Query**|**signUpTotlNum** + __可选__||integer (int32) |**Query**|**slidesId** + __可选__||integer (int32) |**Query**|**startTime** + __可选__||string (date-time) |**Query**|**tag** + __可选__||string |**Query**|**thumbnail** + __可选__||string |**Query**|**thumbsUp** + __可选__||integer (int32) |**Query**|**title** + __可选__||string |**Query**|**type** + __可选__||integer (int32) |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**videoType** + __可选__||integer (int32) |**Query**|**videoUrl** + __可选__||string |**Query**|**videostateId** + __可选__||integer (int32) |**FormData**|**bc_cover** + __可选__|bc_cover|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|integer (int32) |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/edit ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- 0 ---- [[_editnewusingpost]] ==== editNew .... POST /news/editNew .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**approved** + __可选__|integer (int32) |**Query**|**author** + __可选__|string |**Query**|**channelId** + __可选__|string |**Query**|**clicks** + __可选__|integer (int32) |**Query**|**commentCount** + __可选__|integer (int32) |**Query**|**commentsNum** + __可选__|integer (int32) |**Query**|**content** + __可选__|string |**Query**|**cover** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**endTime** + __可选__|string (date-time) |**Query**|**favorite** + __可选__|boolean |**Query**|**id** + __可选__|integer (int32) |**Query**|**newsSource** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**signUpNum** + __可选__|integer (int32) |**Query**|**signUpTotlNum** + __可选__|integer (int32) |**Query**|**slidesId** + __可选__|integer (int32) |**Query**|**startTime** + __可选__|string (date-time) |**Query**|**tag** + __可选__|string |**Query**|**thumbnail** + __可选__|string |**Query**|**thumbsUp** + __可选__|integer (int32) |**Query**|**title** + __可选__|string |**Query**|**type** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**videoType** + __可选__|integer (int32) |**Query**|**videoUrl** + __可选__|string |**Query**|**videostateId** + __可选__|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|integer (int32) |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/editNew ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- 0 ---- [[_getnewsusingget]] ==== 查看新闻(用户登录的状态下可根据user_id查询用户是否收藏过该新闻) .... GET /news/get/{news_id} .... ===== 说明 查看新闻(用户登录的状态下可根据user_id查询用户是否收藏过该新闻) ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**news_id** + __必填__|新闻id|ref |**Query**|**user_id** + __可选__|用户id|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_news,News>> |**400**|该新闻不存在|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/get/ref ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "approved" : 0, "author" : "string", "channelId" : "string", "clicks" : 0, "commentCount" : 0, "commentsNum" : 0, "content" : "string", "cover" : "string", "createTime" : "string", "endTime" : "string", "favorite" : true, "id" : 0, "newsSource" : "string", "realname" : "string", "signUpNum" : 0, "signUpTotlNum" : 0, "slidesId" : 0, "startTime" : "string", "tag" : "string", "thumbnail" : "string", "thumbsUp" : 0, "title" : "string", "type" : 0, "updateTime" : "string", "videoType" : 0, "videoUrl" : "string", "videostateId" : 0 } ---- [[_getnewsbyidusingget]] ==== getNewsById .... GET /news/getById/{news_id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**news_id** + __必填__|news_id|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_news,News>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/getById/string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "approved" : 0, "author" : "string", "channelId" : "string", "clicks" : 0, "commentCount" : 0, "commentsNum" : 0, "content" : "string", "cover" : "string", "createTime" : "string", "endTime" : "string", "favorite" : true, "id" : 0, "newsSource" : "string", "realname" : "string", "signUpNum" : 0, "signUpTotlNum" : 0, "slidesId" : 0, "startTime" : "string", "tag" : "string", "thumbnail" : "string", "thumbsUp" : 0, "title" : "string", "type" : 0, "updateTime" : "string", "videoType" : 0, "videoUrl" : "string", "videostateId" : 0 } ---- [[_querynewslistusingget]] ==== 根据频道id查询该频道下的新闻分页列表 .... GET /news/getNewsList .... ===== 说明 根据频道id查询该频道下的新闻分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**author** + __可选__|编写者|string |**Query**|**channel_id** + __必填__|频道id|ref |**Query**|**endTime** + __可选__|endTime|string |**Query**|**startTime** + __可选__|startTime|string |**Query**|**title** + __可选__|title|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_edff568e39ff129ea3f6a5cf8adf6adf,Page«News»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/getNewsList?channel_id=ref ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "approved" : 0, "author" : "string", "channelId" : "string", "clicks" : 0, "commentCount" : 0, "commentsNum" : 0, "content" : "string", "cover" : "string", "createTime" : "string", "endTime" : "string", "favorite" : true, "id" : 0, "newsSource" : "string", "realname" : "string", "signUpNum" : 0, "signUpTotlNum" : 0, "slidesId" : 0, "startTime" : "string", "tag" : "string", "thumbnail" : "string", "thumbsUp" : 0, "title" : "string", "type" : 0, "updateTime" : "string", "videoType" : 0, "videoUrl" : "string", "videostateId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_querylistusingget]] ==== queryList .... GET /news/queryList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**approved** + __可选__|approved|string |**Query**|**author** + __可选__|author|string |**Query**|**channel_id** + __可选__|channel_id|string |**Query**|**endTime** + __可选__|endTime|string |**Query**|**startTime** + __可选__|startTime|string |**Query**|**title** + __可选__|title|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_edff568e39ff129ea3f6a5cf8adf6adf,Page«News»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /news/queryList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "approved" : 0, "author" : "string", "channelId" : "string", "clicks" : 0, "commentCount" : 0, "commentsNum" : 0, "content" : "string", "cover" : "string", "createTime" : "string", "endTime" : "string", "favorite" : true, "id" : 0, "newsSource" : "string", "realname" : "string", "signUpNum" : 0, "signUpTotlNum" : 0, "slidesId" : 0, "startTime" : "string", "tag" : "string", "thumbnail" : "string", "thumbsUp" : 0, "title" : "string", "type" : 0, "updateTime" : "string", "videoType" : 0, "videoUrl" : "string", "videostateId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_permission-controller_resource]] === Permission-controller Permission Controller [[_addusingpost_6]] ==== add .... POST /permission/add .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**id** + __可选__|integer (int32) |**Query**|**name** + __可选__|string |**Query**|**pid** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**url** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /permission/add ---- [[_batchdelusingdelete_2]] ==== batchDel .... DELETE /permission/batchDel .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**permissionIds** + __必填__|permissionIds|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /permission/batchDel?permissionIds=string ---- [[_deleteusingdelete_4]] ==== delete .... DELETE /permission/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**permissionId** + __必填__|permissionId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /permission/delete?permissionId=string ---- [[_editusingput_7]] ==== edit .... PUT /permission/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**id** + __可选__|integer (int32) |**Query**|**name** + __可选__|string |**Query**|**pid** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**url** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /permission/edit ---- [[_getpermissionlistusingpost]] ==== getPermissionList .... POST /permission/getPermissionList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**math** + __可选__|math|string |**Query**|**name** + __可选__|name|string |**Query**|**paramAlias** + __可选__||string |**Query**|**paramNameValuePairs** + __可选__||object |**Query**|**sqlSelect** + __可选__||string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_b35c7f1cd4f3c4caa27ffd91ec94f2b8,Page«Permission»>> |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /permission/getPermissionList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "createTime" : "string", "id" : 0, "name" : "string", "pid" : 0, "updateTime" : "string", "url" : "string" } ], "size" : 0, "total" : 0 } ---- [[_gettoppermissionlistusingget]] ==== getTopPermissionList .... GET /permission/getTopPermissionList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**paramAlias** + __可选__|string |**Query**|**paramNameValuePairs** + __可选__|object |**Query**|**sqlSelect** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< <<_permission,Permission>> > array |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /permission/getTopPermissionList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { "createTime" : "string", "id" : 0, "name" : "string", "pid" : 0, "updateTime" : "string", "url" : "string" } ] ---- [[_pic-upload-controller_resource]] === Pic-upload-controller Pic Upload Controller [[_uploadusingpost]] ==== upload .... POST /pic/upload .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**FormData**|**bc_cover** + __必填__|bc_cover|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_picuploadresult,PicUploadResult>> |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /pic/upload ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "height" : "string", "url" : "string", "width" : "string" } ---- [[_uploadfileusingpost]] ==== uploadFile .... POST /pic/uploadFile .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**FormData**|**bc_cover** + __必填__|bc_cover|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_picuploadresult,PicUploadResult>> |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /pic/uploadFile ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "height" : "string", "url" : "string", "width" : "string" } ---- [[_ranking-classify-controller_resource]] === Ranking-classify-controller Ranking Classify Controller [[_deleteclassifybyidusingdelete]] ==== deleteClassifyById .... DELETE /rankingClassify/deleteClassifyById .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**classifyId** + __可选__|classifyId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /rankingClassify/deleteClassifyById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_editcontentusingpost_1]] ==== editContent .... POST /rankingClassify/editRankingClassify .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**id** + __可选__||integer (int32) |**Query**|**isTopShow** + __可选__|是否首页显示 1是 0否|integer (int32) |**Query**|**rankClassifyName** + __可选__|排行分类名称|string |**Query**|**sortOrder** + __可选__||integer (int32) |**Query**|**updateTime** + __可选__||string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /rankingClassify/editRankingClassify ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_findclassifybyidusingget]] ==== findClassifyById .... GET /rankingClassify/findClassifyById .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**classifyId** + __可选__|classifyId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /rankingClassify/findClassifyById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getclassifylistusingget]] ==== 查询排行分类列表 .... GET /rankingClassify/getClassifyList .... ===== 说明 排行分类列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_0fe60ae86270844597a23b3864495439,Page«RankingClassify»>> |=== ===== 生成 * `\*/*` * `application/json` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /rankingClassify/getClassifyList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "createTime" : "string", "id" : 0, "isTopShow" : 0, "rankClassifyName" : "string", "sortOrder" : 0, "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- [[_ranking-controller_resource]] === Ranking-controller Ranking Controller [[_addrankingclassifyusingpost]] ==== addRankingClassify .... POST /ranking/addRankingClassify .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**alias** + __可选__|别名|string |**Query**|**background** + __可选__|背景图|string |**Query**|**classifyId** + __可选__||integer (int32) |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**id** + __可选__||integer (int32) |**Query**|**rankName** + __可选__|排行名称|string |**Query**|**topImg** + __可选__|头图|string |**Query**|**updateTime** + __可选__||string (date-time) |**Body**|**classify** + __必填__|classify|< <<_4998b3569615b7a93bfc703396747ee9,Map«string,object»>> > array |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ranking/addRankingClassify ---- ====== 请求 body [source,json] ---- [ null ] ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deleteclassifybyidusingdelete_1]] ==== deleteClassifyById .... DELETE /ranking/deleteClassifyById .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**rankId** + __可选__|rankId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ranking/deleteClassifyById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_findclassifybyidusingget_1]] ==== findClassifyById .... GET /ranking/findClassifyById .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**rankId** + __可选__|rankId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ranking/findClassifyById ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_updaterankingclassifyusingpost]] ==== updateRankingClassify .... POST /ranking/updateRankingClassify .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**alias** + __可选__|别名|string |**Query**|**background** + __可选__|背景图|string |**Query**|**classifyId** + __可选__||integer (int32) |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**id** + __可选__||integer (int32) |**Query**|**rankName** + __可选__|排行名称|string |**Query**|**topImg** + __可选__|头图|string |**Query**|**updateTime** + __可选__||string (date-time) |**Body**|**classify** + __必填__|classify|< <<_4998b3569615b7a93bfc703396747ee9,Map«string,object»>> > array |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ranking/updateRankingClassify ---- ====== 请求 body [source,json] ---- [ null ] ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_reg-controller_resource]] === Reg-controller Reg Controller [[_perfectinfousingpost]] ==== perfectInfo .... POST /reg/perfectInfo .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**avatar** + __可选__|string |**Query**|**birthday** + __可选__|string (date-time) |**Query**|**certificatesId** + __可选__|string |**Query**|**city** + __可选__|string |**Query**|**clubName** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**district** + __可选__|string |**Query**|**email** + __可选__|string |**Query**|**enabled** + __可选__|integer (int32) |**Query**|**id** + __可选__|integer (int32) |**Query**|**introduction** + __可选__|string |**Query**|**isLive** + __可选__|integer (int32) |**Query**|**jwtToken** + __可选__|string |**Query**|**lastLoginIp** + __可选__|string |**Query**|**lastLoginTime** + __可选__|string (date-time) |**Query**|**logo** + __可选__|string |**Query**|**managerName** + __可选__|string |**Query**|**mobile** + __可选__|string |**Query**|**openId** + __可选__|string |**Query**|**password** + __可选__|string |**Query**|**passwordHash** + __可选__|string (byte) |**Query**|**passwordSalt** + __可选__|string (byte) |**Query**|**post** + __可选__|string |**Query**|**province** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**registIp** + __可选__|string |**Query**|**registTime** + __可选__|string (date-time) |**Query**|**roleId** + __可选__|integer (int32) |**Query**|**sex** + __可选__|integer (int32) |**Query**|**totalLoginCounts** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**userType** + __可选__|integer (int32) |**Query**|**username** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /reg/perfectInfo ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_registusingpost]] ==== regist .... POST /reg/regist .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**avatar** + __可选__||string |**Query**|**birthday** + __可选__||string (date-time) |**Query**|**certificatesId** + __可选__||string |**Query**|**city** + __可选__||string |**Query**|**clubName** + __可选__||string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**district** + __可选__||string |**Query**|**email** + __可选__||string |**Query**|**enabled** + __可选__||integer (int32) |**Query**|**id** + __可选__||integer (int32) |**Query**|**introduction** + __可选__||string |**Query**|**isLive** + __可选__||integer (int32) |**Query**|**jwtToken** + __可选__||string |**Query**|**lastLoginIp** + __可选__||string |**Query**|**lastLoginTime** + __可选__||string (date-time) |**Query**|**logo** + __可选__||string |**Query**|**managerName** + __可选__||string |**Query**|**mobile** + __可选__||string |**Query**|**openId** + __可选__||string |**Query**|**password** + __可选__||string |**Query**|**passwordHash** + __可选__||string (byte) |**Query**|**passwordSalt** + __可选__||string (byte) |**Query**|**post** + __可选__||string |**Query**|**province** + __可选__||string |**Query**|**realname** + __可选__||string |**Query**|**registIp** + __可选__||string |**Query**|**registTime** + __可选__||string (date-time) |**Query**|**roleId** + __可选__||integer (int32) |**Query**|**sex** + __可选__||integer (int32) |**Query**|**smsCode** + __必填__|smsCode|string |**Query**|**totalLoginCounts** + __可选__||integer (int32) |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**userType** + __可选__||integer (int32) |**Query**|**username** + __可选__||string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /reg/regist?smsCode=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_validateusernameusingpost]] ==== validateUsername .... POST /reg/validateUsername .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**mobile** + __必填__|mobile|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /reg/validateUsername?mobile=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_role-controller_resource]] === Role-controller Role Controller [[_addusingpost_7]] ==== add .... POST /role/add .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**alias** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**explain** + __可选__|string |**Query**|**flag** + __可选__|string |**Query**|**id** + __可选__|integer (int32) |**Query**|**name** + __可选__|string |**Query**|**status** + __可选__|string |**Query**|**updateTime** + __可选__|string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /role/add ---- [[_deleteusingdelete_5]] ==== delete .... DELETE /role/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**roleId** + __必填__|roleId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|string |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /role/delete?roleId=0 ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "string" ---- [[_editusingput_8]] ==== edit .... PUT /role/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**alias** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**explain** + __可选__|string |**Query**|**flag** + __可选__|string |**Query**|**id** + __可选__|integer (int32) |**Query**|**name** + __可选__|string |**Query**|**status** + __可选__|string |**Query**|**updateTime** + __可选__|string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /role/edit ---- [[_getrolelistusingget]] ==== getRoleList .... GET /role/getRoleList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**name** + __可选__|name|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_418738a9a7914b43b88074d53bb74d81,Page«Role»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /role/getRoleList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "alias" : "string", "createTime" : "string", "explain" : "string", "flag" : "string", "id" : 0, "name" : "string", "rolePermissionList" : [ { "createTime" : "string", "id" : 0, "pid" : 0, "rid" : 0, "updateTime" : "string" } ], "status" : "string", "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- [[_rightsusingget]] ==== rights .... GET /role/rights/{roleId} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**roleId** + __必填__|roleId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< <<_fe5293b8150fdf81185174959d77609c,Map«string,string»>> > array |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /role/rights/0 ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { } ] ---- [[_updaterolerightsusingpost]] ==== updateRoleRights .... POST /role/updateRoleRights .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**alias** + __可选__||string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**explain** + __可选__||string |**Query**|**flag** + __可选__||string |**Query**|**id** + __可选__||integer (int32) |**Query**|**name** + __可选__||string |**Query**|**rights** + __可选__|rights|string |**Query**|**status** + __可选__||string |**Query**|**updateTime** + __可选__||string (date-time) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /role/updateRoleRights ---- [[_search-controller_resource]] === Search-controller Search Controller [[_searchcontentbycontentusingget]] ==== 搜索评论接口 .... GET /search/comment/{keywords} .... ===== 说明 搜索评论接口 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**keywords** + __可选__|评论关键词|string |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< <<_comment,Comment>> > array |=== ===== 生成 * `\*/*` * `application/json` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /search/comment/string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { "childrenCount" : 0, "content" : "string", "contentId" : 0, "createTime" : "string", "forumId" : 0, "id" : 0, "mentionedComment" : "string", "parentId" : 0, "stars" : 0, "timeRange" : "string", "updateTime" : "string", "userId" : 0 } ] ---- [[_initusingget]] ==== 清空索引 .... GET /search/init .... ===== 说明 清空索引 ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /search/init ---- [[_slide-controller_resource]] === Slide-controller Slide Controller [[_addusingpost_8]] ==== 添加轮播图 .... POST /slide/add .... ===== 说明 添加轮播图 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**banner** + __可选__|封面图|string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**id** + __可选__|轮播图ID|integer (int32) |**Query**|**link** + __可选__|超链接|string |**Query**|**navType** + __可选__||integer (int32) |**Query**|**sortorder** + __可选__||integer (int32) |**Query**|**title** + __可选__|标题|string |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**videoCover** + __可选__||string |**FormData**|**cover** + __可选__|封面图|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /slide/add ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deleteslideusingdelete]] ==== 删除轮播图 .... DELETE /slide/delete .... ===== 说明 删除轮播图 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**slideId** + __可选__|轮播图ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /slide/delete ---- [[_editusingput_9]] ==== edit .... PUT /slide/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**banner** + __可选__|封面图|string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**id** + __可选__|轮播图ID|integer (int32) |**Query**|**link** + __可选__|超链接|string |**Query**|**navType** + __可选__||integer (int32) |**Query**|**sortorder** + __可选__||integer (int32) |**Query**|**title** + __可选__|标题|string |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**videoCover** + __可选__||string |**FormData**|**cover** + __可选__|封面图|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /slide/edit ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getslideusingget]] ==== getSlide .... GET /slide/get/{id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**id** + __必填__|id|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_0c0180cb06a322199a67f10d4ec41cd5,轮播图>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /slide/get/string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "banner" : "string", "createTime" : "string", "id" : 0, "link" : "https://www.baidu.com/", "navType" : 0, "sortorder" : 0, "title" : "string", "updateTime" : "string", "videoCover" : "string" } ---- [[_getslidelistusingget]] ==== 查询轮播图列表(默认倒序) .... GET /slide/getSlideList .... ===== 说明 查询轮播图列表(默认倒序) ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< <<_0c0180cb06a322199a67f10d4ec41cd5,轮播图>> > array |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /slide/getSlideList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { "banner" : "string", "createTime" : "string", "id" : 0, "link" : "https://www.baidu.com/", "navType" : 0, "sortorder" : 0, "title" : "string", "updateTime" : "string", "videoCover" : "string" } ] ---- [[_getslidepagelistusingget]] ==== 查询轮播图分页列表(默认倒序) .... GET /slide/getSlidePageList .... ===== 说明 查询轮播图分页列表(默认倒序) ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_43e7db15c6931e6b836b815d19bb2b83,Page«轮播图»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /slide/getSlidePageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "banner" : "string", "createTime" : "string", "id" : 0, "link" : "https://www.baidu.com/", "navType" : 0, "sortorder" : 0, "title" : "string", "updateTime" : "string", "videoCover" : "string" } ], "size" : 0, "total" : 0 } ---- [[_updatesortorderusingput_2]] ==== 对轮播图排序(默认分页列表为倒序) .... PUT /slide/updateSortorder .... ===== 说明 对轮播图排序(默认分页列表为倒序) ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**moveType** + __可选__|移动类型(up/down)|string |**Query**|**sourceId** + __可选__|源实体ID|ref |**Query**|**targetId** + __可选__|目标实体ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /slide/updateSortorder ---- [[_ue-controller_resource]] === Ue-controller Ue Controller [[_configusingpost]] ==== config .... POST /ueditor/dispatch .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**action** + __可选__|action|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ueditor/dispatch ---- [[_configusingget]] ==== config .... GET /ueditor/dispatch .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**action** + __可选__|action|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ueditor/dispatch ---- [[_configusingput]] ==== config .... PUT /ueditor/dispatch .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**action** + __可选__|action|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ueditor/dispatch ---- [[_configusingdelete]] ==== config .... DELETE /ueditor/dispatch .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**action** + __可选__|action|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ueditor/dispatch ---- [[_configusingpatch]] ==== config .... PATCH /ueditor/dispatch .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**action** + __可选__|action|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ueditor/dispatch ---- [[_configusinghead]] ==== config .... HEAD /ueditor/dispatch .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**action** + __可选__|action|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ueditor/dispatch ---- [[_configusingoptions]] ==== config .... OPTIONS /ueditor/dispatch .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**action** + __可选__|action|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /ueditor/dispatch ---- [[_user-comment-controller_resource]] === User-comment-controller User Comment Controller [[_getusercommentlistusingget]] ==== 根据token查询我的评论分页列表 .... GET /userComment/getUserCommentList .... ===== 说明 根据token查询我的评论分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_c333954711cf896dc054efb257570d23,Page«UserComment»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /userComment/getUserCommentList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "commentId" : 0, "contentId" : 0, "createTime" : "string", "id" : 0, "updateTime" : "string", "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_user-controller_resource]] === User-controller User Controller [[_addusingpost_9]] ==== add .... POST /user/add .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**avatar** + __可选__|string |**Query**|**birthday** + __可选__|string (date-time) |**Query**|**certificatesId** + __可选__|string |**Query**|**city** + __可选__|string |**Query**|**clubName** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**district** + __可选__|string |**Query**|**email** + __可选__|string |**Query**|**enabled** + __可选__|integer (int32) |**Query**|**id** + __可选__|integer (int32) |**Query**|**introduction** + __可选__|string |**Query**|**isLive** + __可选__|integer (int32) |**Query**|**jwtToken** + __可选__|string |**Query**|**lastLoginIp** + __可选__|string |**Query**|**lastLoginTime** + __可选__|string (date-time) |**Query**|**logo** + __可选__|string |**Query**|**managerName** + __可选__|string |**Query**|**mobile** + __可选__|string |**Query**|**openId** + __可选__|string |**Query**|**password** + __可选__|string |**Query**|**passwordHash** + __可选__|string (byte) |**Query**|**passwordSalt** + __可选__|string (byte) |**Query**|**post** + __可选__|string |**Query**|**province** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**registIp** + __可选__|string |**Query**|**registTime** + __可选__|string (date-time) |**Query**|**roleId** + __可选__|integer (int32) |**Query**|**sex** + __可选__|integer (int32) |**Query**|**totalLoginCounts** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**userType** + __可选__|integer (int32) |**Query**|**username** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/add ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_batchdelusingpost]] ==== batchDel .... POST /user/batchDel .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**userIds** + __可选__|userIds|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/batchDel ---- [[_deleteuserusingpost]] ==== deleteUser .... POST /user/delete .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**userId** + __可选__|userId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/delete ---- [[_disableuserusingpost]] ==== disableUser .... POST /user/disable .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**userId** + __可选__|userId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/disable ---- [[_edituserusingpost]] ==== editUser .... POST /user/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**mobile** + __必填__|mobile|string |**Query**|**nickname** + __必填__|nickname|string |**FormData**|**uploadFile** + __可选__|uploadFile|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/edit?mobile=string&nickname=string ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_editusingpost_1]] ==== edit .... POST /user/editUser .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"] |=== |类型|名称|说明|类型|默认值 |**Query**|**isAvatar** + __可选__|isAvatar|integer (int32)|`1` |**Query**|**mobile** + __必填__|mobile|string| |**Query**|**nickname** + __可选__|nickname|string| |**Query**|**sex** + __可选__|sex|integer (int32)| |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/editUser?mobile=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_enableuserusingpost]] ==== enableUser .... POST /user/enable .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**userId** + __可选__|userId|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/enable ---- [[_findpwdusingpost]] ==== findpwd .... POST /user/findpwd .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**mobile** + __必填__|mobile|string |**Query**|**password** + __必填__|password|string |**Query**|**verifyCode** + __可选__|verifyCode|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/findpwd?mobile=string&password=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getusingget_2]] ==== get .... GET /user/get/{Id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**Id** + __必填__|Id|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_user,User>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/get/string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "authCacheKey" : "string", "avatar" : "string", "birthday" : "string", "certificatesId" : "string", "city" : "string", "clubName" : "string", "createTime" : "string", "district" : "string", "email" : "string", "enabled" : 0, "id" : 0, "introduction" : "string", "isLive" : 0, "jwtToken" : "string", "lastLoginIp" : "string", "lastLoginTime" : "string", "logo" : "string", "managerName" : "string", "mobile" : "string", "openId" : "string", "password" : "string", "passwordHash" : "string", "passwordSalt" : "string", "post" : "string", "province" : "string", "realname" : "string", "registIp" : "string", "registTime" : "string", "roleId" : 0, "sex" : 0, "totalLoginCounts" : 0, "updateTime" : "string", "userType" : 0, "username" : "string" } ---- [[_getpermissionmenuusingget]] ==== getPermissionMenu .... GET /user/getPermissionMenuTree .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**paramAlias** + __可选__||string |**Query**|**paramNameValuePairs** + __可选__||object |**Query**|**sqlSelect** + __可选__||string |**Query**|**user_id** + __可选__|user_id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< <<_fe5293b8150fdf81185174959d77609c,Map«string,string»>> > array |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/getPermissionMenuTree ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { } ] ---- [[_getpermissiontreeusingget]] ==== getPermissionTree .... GET /user/getPermissionTree .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**paramAlias** + __可选__||string |**Query**|**paramNameValuePairs** + __可选__||object |**Query**|**sqlSelect** + __可选__||string |**Query**|**user_id** + __可选__|user_id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< <<_fe5293b8150fdf81185174959d77609c,Map«string,string»>> > array |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/getPermissionTree ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { } ] ---- [[_getuserbytokenusingget]] ==== getUserByToken .... GET /user/getUserByToken .... ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_user,User>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/getUserByToken ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "authCacheKey" : "string", "avatar" : "string", "birthday" : "string", "certificatesId" : "string", "city" : "string", "clubName" : "string", "createTime" : "string", "district" : "string", "email" : "string", "enabled" : 0, "id" : 0, "introduction" : "string", "isLive" : 0, "jwtToken" : "string", "lastLoginIp" : "string", "lastLoginTime" : "string", "logo" : "string", "managerName" : "string", "mobile" : "string", "openId" : "string", "password" : "string", "passwordHash" : "string", "passwordSalt" : "string", "post" : "string", "province" : "string", "realname" : "string", "registIp" : "string", "registTime" : "string", "roleId" : 0, "sex" : 0, "totalLoginCounts" : 0, "updateTime" : "string", "userType" : 0, "username" : "string" } ---- [[_queryuserlistusingget_1]] ==== queryUserList .... GET /user/getUserList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**column** + __可选__|column|string |**Query**|**isLive** + __可选__|isLive|integer (int32) |**Query**|**keyword** + __可选__|keyword|string |**Query**|**mobile** + __可选__|mobile|string |**Query**|**paramAlias** + __可选__||string |**Query**|**paramNameValuePairs** + __可选__||object |**Query**|**sqlSelect** + __可选__||string |**Query**|**username** + __可选__|username|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_e74dd976185b63fab3d0c002ca14d581,Page«User»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/getUserList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "authCacheKey" : "string", "avatar" : "string", "birthday" : "string", "certificatesId" : "string", "city" : "string", "clubName" : "string", "createTime" : "string", "district" : "string", "email" : "string", "enabled" : 0, "id" : 0, "introduction" : "string", "isLive" : 0, "jwtToken" : "string", "lastLoginIp" : "string", "lastLoginTime" : "string", "logo" : "string", "managerName" : "string", "mobile" : "string", "openId" : "string", "password" : "string", "passwordHash" : "string", "passwordSalt" : "string", "post" : "string", "province" : "string", "realname" : "string", "registIp" : "string", "registTime" : "string", "roleId" : 0, "sex" : 0, "totalLoginCounts" : 0, "updateTime" : "string", "userType" : 0, "username" : "string" } ], "size" : 0, "total" : 0 } ---- [[_getuserpagelistusingget]] ==== getUserPageList .... GET /user/getUserPageList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**column** + __可选__|column|string |**Query**|**isLive** + __可选__|isLive|integer (int32) |**Query**|**keyword** + __可选__|keyword|string |**Query**|**mobile** + __可选__|mobile|string |**Query**|**username** + __可选__|username|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_e74dd976185b63fab3d0c002ca14d581,Page«User»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/getUserPageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "authCacheKey" : "string", "avatar" : "string", "birthday" : "string", "certificatesId" : "string", "city" : "string", "clubName" : "string", "createTime" : "string", "district" : "string", "email" : "string", "enabled" : 0, "id" : 0, "introduction" : "string", "isLive" : 0, "jwtToken" : "string", "lastLoginIp" : "string", "lastLoginTime" : "string", "logo" : "string", "managerName" : "string", "mobile" : "string", "openId" : "string", "password" : "string", "passwordHash" : "string", "passwordSalt" : "string", "post" : "string", "province" : "string", "realname" : "string", "registIp" : "string", "registTime" : "string", "roleId" : 0, "sex" : 0, "totalLoginCounts" : 0, "updateTime" : "string", "userType" : 0, "username" : "string" } ], "size" : 0, "total" : 0 } ---- [[_getwxuserlistusingget]] ==== getWXUserList .... GET /user/getWXUserList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**name** + __可选__|name|string |**Query**|**paramAlias** + __可选__||string |**Query**|**paramNameValuePairs** + __可选__||object |**Query**|**phone** + __可选__|phone|string |**Query**|**sqlSelect** + __可选__||string |**Query**|**type** + __可选__|type|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_e74dd976185b63fab3d0c002ca14d581,Page«User»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/getWXUserList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "authCacheKey" : "string", "avatar" : "string", "birthday" : "string", "certificatesId" : "string", "city" : "string", "clubName" : "string", "createTime" : "string", "district" : "string", "email" : "string", "enabled" : 0, "id" : 0, "introduction" : "string", "isLive" : 0, "jwtToken" : "string", "lastLoginIp" : "string", "lastLoginTime" : "string", "logo" : "string", "managerName" : "string", "mobile" : "string", "openId" : "string", "password" : "string", "passwordHash" : "string", "passwordSalt" : "string", "post" : "string", "province" : "string", "realname" : "string", "registIp" : "string", "registTime" : "string", "roleId" : 0, "sex" : 0, "totalLoginCounts" : 0, "updateTime" : "string", "userType" : 0, "username" : "string" } ], "size" : 0, "total" : 0 } ---- [[_editusingput_10]] ==== edit .... PUT /user/modify .... ===== 参数 [options="header", cols=".^2a,.^3a,.^4a"] |=== |类型|名称|类型 |**Query**|**avatar** + __可选__|string |**Query**|**birthday** + __可选__|string (date-time) |**Query**|**certificatesId** + __可选__|string |**Query**|**city** + __可选__|string |**Query**|**clubName** + __可选__|string |**Query**|**createTime** + __可选__|string (date-time) |**Query**|**district** + __可选__|string |**Query**|**email** + __可选__|string |**Query**|**enabled** + __可选__|integer (int32) |**Query**|**id** + __可选__|integer (int32) |**Query**|**introduction** + __可选__|string |**Query**|**isLive** + __可选__|integer (int32) |**Query**|**jwtToken** + __可选__|string |**Query**|**lastLoginIp** + __可选__|string |**Query**|**lastLoginTime** + __可选__|string (date-time) |**Query**|**logo** + __可选__|string |**Query**|**managerName** + __可选__|string |**Query**|**mobile** + __可选__|string |**Query**|**openId** + __可选__|string |**Query**|**password** + __可选__|string |**Query**|**passwordHash** + __可选__|string (byte) |**Query**|**passwordSalt** + __可选__|string (byte) |**Query**|**post** + __可选__|string |**Query**|**province** + __可选__|string |**Query**|**realname** + __可选__|string |**Query**|**registIp** + __可选__|string |**Query**|**registTime** + __可选__|string (date-time) |**Query**|**roleId** + __可选__|integer (int32) |**Query**|**sex** + __可选__|integer (int32) |**Query**|**totalLoginCounts** + __可选__|integer (int32) |**Query**|**updateTime** + __可选__|string (date-time) |**Query**|**userType** + __可选__|integer (int32) |**Query**|**username** + __可选__|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/modify ---- [[_queryuserpermsusingget]] ==== queryUserPerms .... GET /user/queryUserPerms/{Id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**Id** + __必填__|Id|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, integer (int32) > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/queryUserPerms/string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_registusingpost_1]] ==== regist .... POST /user/regist .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**avatar** + __可选__||string |**Query**|**birthday** + __可选__||string (date-time) |**Query**|**certificatesId** + __可选__||string |**Query**|**city** + __可选__||string |**Query**|**clubName** + __可选__||string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**district** + __可选__||string |**Query**|**email** + __可选__||string |**Query**|**enabled** + __可选__||integer (int32) |**Query**|**id** + __可选__||integer (int32) |**Query**|**introduction** + __可选__||string |**Query**|**isLive** + __可选__||integer (int32) |**Query**|**jwtToken** + __可选__||string |**Query**|**lastLoginIp** + __可选__||string |**Query**|**lastLoginTime** + __可选__||string (date-time) |**Query**|**logo** + __可选__||string |**Query**|**managerName** + __可选__||string |**Query**|**mobile** + __可选__||string |**Query**|**openId** + __可选__||string |**Query**|**password** + __可选__||string |**Query**|**passwordHash** + __可选__||string (byte) |**Query**|**passwordSalt** + __可选__||string (byte) |**Query**|**post** + __可选__||string |**Query**|**province** + __可选__||string |**Query**|**realname** + __可选__||string |**Query**|**registIp** + __可选__||string |**Query**|**registTime** + __可选__||string (date-time) |**Query**|**roleId** + __可选__||integer (int32) |**Query**|**sex** + __可选__||integer (int32) |**Query**|**totalLoginCounts** + __可选__||integer (int32) |**Query**|**updateTime** + __可选__||string (date-time) |**Query**|**userType** + __可选__||integer (int32) |**Query**|**username** + __可选__||string |**Query**|**verifyCode** + __必填__|verifyCode|string |**Query**|**weixinUnid** + __可选__|weixinUnid|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/regist?verifyCode=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_updatepassusingpost]] ==== updatePass .... POST /user/updatePass .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**id** + __必填__|id|string |**Query**|**mobile** + __必填__|mobile|string |**Query**|**oldPassWord** + __必填__|oldPassWord|string |**Query**|**password** + __必填__|password|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /user/updatePass?id=string&mobile=string&oldPassWord=string&password=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_user-course-controller_resource]] === User-course-controller User Course Controller [[_getmycourselistusingget]] ==== 查看我的课程列表 .... GET /userCourse/getMyCourseList .... ===== 说明 查看我的课程列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Header**|**Authorization** + __必填__|Authorization|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_8457a44897358069075a70a419deb8ca,Page«用户课程»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /userCourse/getMyCourseList ---- ====== 请求 header [source,json] ---- "string" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "chapterId" : 0, "complete" : true, "courseId" : 0, "cseriesId" : 0, "lastStudyTime" : "string", "schedule" : 0, "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_user-favourites-controller_resource]] === User-favourites-controller User Favourites Controller [[_getfavouritesusingget]] ==== getFavourites .... GET /userFavourites/getFavorites .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_d7a0dcbd107b55ce300a54f6c5edc271,Page«UserFavorites»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /userFavourites/getFavorites ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "contentId" : 0, "id" : 0, "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_getfavoritesdetailusingget]] ==== getFavoritesDetail .... GET /userFavourites/getFavoritesDetail .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentId** + __可选__|contentId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /userFavourites/getFavoritesDetail ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_giveupfavoritesusingdelete]] ==== giveUpFavorites .... DELETE /userFavourites/giveUpFavorites .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**favoritesId** + __可选__|favoritesId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /userFavourites/giveUpFavorites ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_insertfavoritesusingpost]] ==== insertFavorites .... POST /userFavourites/insertFavorites .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentId** + __可选__|contentId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /userFavourites/insertFavorites ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_user-star-controller_resource]] === User-star-controller User Star Controller [[_addusingpost_10]] ==== add .... POST /star/add .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentId** + __可选__|contentId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /star/add ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_cancelusingdelete]] ==== cancel .... DELETE /star/cancel .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**starId** + __可选__|starId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /star/cancel ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getdetailusingget]] ==== getDetail .... GET /star/getDetail .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**contentId** + __可选__|contentId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /star/getDetail ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_getstarpagelistusingget]] ==== getStarPageList .... GET /star/getStarPageList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_96e7f3d545e5ff9453abf586bac52683,Page«UserStar»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /star/getStarPageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "content" : { "atTop" : true, "banner" : "string", "clicks" : 0, "commentCount" : 0, "content" : "string", "contentType" : 0, "cover" : "string", "createTime" : "string", "favourites" : 0, "forumId" : 0, "forwardingCount" : 0, "hasRead" : true, "hasVote" : 0, "id" : 0, "sources" : "string", "stars" : 0, "styleId" : 0, "subtitle" : "string", "thumbnail" : "string", "timeRange" : "string", "title" : "string", "updateTime" : "string", "videoUrl" : "string", "voteId" : 0 }, "contentId" : 0, "createTime" : "string", "id" : 0, "updateTime" : "string", "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_video-upload-controller_resource]] === Video-upload-controller Video Upload Controller [[_uploadusingpost_1]] ==== upload .... POST /file/upload .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**FormData**|**bc_file** + __必填__|bc_file|file |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_picuploadresult,PicUploadResult>> |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /file/upload ---- ====== 请求 formData [source,json] ---- "file" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "height" : "string", "url" : "string", "width" : "string" } ---- [[_vote-controller_resource]] === Vote-controller Vote Controller [[_addvoteusingpost]] ==== addVote .... POST /vote/addVote .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**closed** + __可选__|是否已结束 1:true 0:false|boolean |**Query**|**contents** + __可选__|contents|< string > array(multi) |**Query**|**endTime** + __可选__|结束时间|string (date-time) |**Query**|**id** + __可选__|投票ID|integer (int32) |**Query**|**isUsed** + __可选__|是否被使用 1：未使用 0：已被使用|string |**Query**|**multiSelected** + __可选__|是否多选标志 1:true多选 0:false单选|boolean |**Query**|**startTime** + __可选__|开始时间|string (date-time) |**Query**|**title** + __可选__||string |**Query**|**totalCount** + __可选__|投票总数|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /vote/addVote ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_deletevoteoptionusingdelete]] ==== deleteVoteOption .... DELETE /vote/deleteVote .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**id** + __可选__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /vote/deleteVote ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_editvoteusingpost]] ==== editVote .... POST /vote/editVote .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**closed** + __可选__|是否已结束 1:true 0:false|boolean |**Query**|**contentId** + __可选__|contentId|< string > array(multi) |**Query**|**contents** + __可选__|contents|< string > array(multi) |**Query**|**deleteContentId** + __可选__|deleteContentId|< string > array(multi) |**Query**|**endTime** + __可选__|结束时间|string (date-time) |**Query**|**id** + __可选__|投票ID|integer (int32) |**Query**|**isUsed** + __可选__|是否被使用 1：未使用 0：已被使用|string |**Query**|**multiSelected** + __可选__|是否多选标志 1:true多选 0:false单选|boolean |**Query**|**startTime** + __可选__|开始时间|string (date-time) |**Query**|**title** + __可选__||string |**Query**|**totalCount** + __可选__|投票总数|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /vote/editVote ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_toeidtusingget]] ==== toEidt .... GET /vote/toEdit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**id** + __可选__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /vote/toEdit ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_votepageusingget]] ==== votePage .... GET /vote/voteList .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**title** + __可选__|title|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|<<_d0876c5d78b163a52e397f1537844bfc,Page«Vote»>> |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /vote/voteList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "closed" : true, "endTime" : "string", "id" : 0, "isUsed" : "string", "multiSelected" : true, "startTime" : "string", "title" : "string", "totalCount" : 0 } ], "size" : 0, "total" : 0 } ---- [[_votesusingget]] ==== votes .... GET /vote/votes .... ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< <<_vote,Vote>> > array |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /vote/votes ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { "closed" : true, "endTime" : "string", "id" : 0, "isUsed" : "string", "multiSelected" : true, "startTime" : "string", "title" : "string", "totalCount" : 0 } ] ---- [[_vote-option-controller_resource]] === Vote-option-controller Vote Option Controller [[_addvoteusingpost_1]] ==== addVote .... POST /voteOption/addVote .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**optionsId** + __可选__|optionsId|< string > array(multi) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|< string, object > map |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /voteOption/addVote ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_we-chat-login-controller_resource]] === We-chat-login-controller We Chat Login Controller [[_getweixinloginurlusingget]] ==== getWeiXinLoginUrl .... GET /weChatLogin/getWeChatLoginUrl .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**url** + __可选__|url|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|string |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /weChatLogin/getWeChatLoginUrl ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "string" ---- [[_goindexusingget]] ==== goIndex .... GET /weChatLogin/goIndex .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**code** + __可选__|code|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|OK|object |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /weChatLogin/goIndex ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_992f430e8c9c106d19384301dbdafc57]] === 课程业务接口 Course Controller [[_addusingpost_1]] ==== 添加课程 .... POST /course/add .... ===== 说明 添加课程 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**articleAmount** + __可选__|总课时|integer (int32) |**Query**|**basicContent** + __可选__|基础信息|string |**Query**|**commentCount** + __可选__|评论数量|integer (int32) |**Query**|**cover** + __可选__|封面|string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**enrolment** + __可选__|报名人数|integer (int32) |**Query**|**id** + __可选__|课程ID|integer (int32) |**Query**|**name** + __可选__|课程名称|string |**Query**|**online** + __可选__|课程状态|boolean |**Query**|**price** + __可选__|课程价格(默认是0)|number |**Query**|**updateTime** + __可选__||string (date-time) |**FormData**|**banner** + __可选__|LOGO|file |**Body**|**courseSerieses** + __必填__|courseSerieses|< <<_12a470c08b63dc040012f9e34a72737e,课程-课程系列多对多关联>> > array |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|< string, object > map |**201**|POST请求正常完成|< string, object > map |**204**|PUT/DELETE请求正常完成|< string, object > map |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /course/add ---- ====== 请求 formData [source,json] ---- "file" ---- ====== 请求 body [source,json] ---- [ { "courseId" : 0, "seriesId" : 0 } ] ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- ====== 响应 201 [source,json] ---- "object" ---- ====== 响应 204 [source,json] ---- "object" ---- [[_deletecourseusingdelete]] ==== 删除课程 .... DELETE /course/delete .... ===== 说明 删除课程 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**courseId** + __可选__|课程ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|无内容 |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /course/delete ---- [[_editusingput_2]] ==== edit .... PUT /course/edit .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**articleAmount** + __可选__|总课时|integer (int32) |**Query**|**basicContent** + __可选__|基础信息|string |**Query**|**commentCount** + __可选__|评论数量|integer (int32) |**Query**|**cover** + __可选__|封面|string |**Query**|**createTime** + __可选__||string (date-time) |**Query**|**enrolment** + __可选__|报名人数|integer (int32) |**Query**|**id** + __可选__|课程ID|integer (int32) |**Query**|**name** + __可选__|课程名称|string |**Query**|**online** + __可选__|课程状态|boolean |**Query**|**price** + __可选__|课程价格(默认是0)|number |**Query**|**updateTime** + __可选__||string (date-time) |**FormData**|**banner** + __可选__|封面图|file |**Body**|**courseSerieses** + __必填__|courseSerieses|< <<_12a470c08b63dc040012f9e34a72737e,课程-课程系列多对多关联>> > array |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|< string, object > map |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 消耗 * `multipart/form-data` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /course/edit ---- ====== 请求 formData [source,json] ---- "file" ---- ====== 请求 body [source,json] ---- [ { "courseId" : 0, "seriesId" : 0 } ] ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- [[_enrollusingpost]] ==== 报名 .... POST /course/enroll .... ===== 说明 报名 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Header**|**Authorizatior** + __必填__|Authorizatior|string |**Query**|**courseId** + __可选__|课程ID|ref |**Query**|**cseriesId** + __可选__|课程系列ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|< string, object > map |**201**|POST请求正常完成|< string, object > map |**204**|PUT/DELETE请求正常完成|< string, object > map |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /course/enroll ---- ====== 请求 header [source,json] ---- "string" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- ====== 响应 201 [source,json] ---- "object" ---- ====== 响应 204 [source,json] ---- "object" ---- [[_getusingget]] ==== 查询单个课程 .... GET /course/get/cseriesId/{courseId} .... ===== 说明 查询单个课程 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**courseId** + __可选__|课程ID|ref |**Path**|**cseriesId** + __可选__|课程系列ID|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_course,Course>> |**201**|POST请求正常完成|<<_course,Course>> |**204**|PUT/DELETE请求正常完成|<<_course,Course>> |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /course/get/cseriesId/ref ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "articleAmount" : 0, "basicContent" : "string", "commentCount" : 0, "cover" : "string", "createTime" : "string", "enrolment" : 0, "id" : 0, "name" : "string", "online" : true, "price" : 0.0, "updateTime" : "string" } ---- ====== 响应 201 [source,json] ---- { "articleAmount" : 0, "basicContent" : "string", "commentCount" : 0, "cover" : "string", "createTime" : "string", "enrolment" : 0, "id" : 0, "name" : "string", "online" : true, "price" : 0.0, "updateTime" : "string" } ---- ====== 响应 204 [source,json] ---- { "articleAmount" : 0, "basicContent" : "string", "commentCount" : 0, "cover" : "string", "createTime" : "string", "enrolment" : 0, "id" : 0, "name" : "string", "online" : true, "price" : 0.0, "updateTime" : "string" } ---- [[_getcoursepagelistusingget_1]] ==== 查询课程分页列表 .... GET /course/getCoursePageList .... ===== 说明 查询课程分页列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_7df42878154cc2753b37c65d4654dea5,Page«Course»>> |**201**|POST请求正常完成|<<_7df42878154cc2753b37c65d4654dea5,Page«Course»>> |**204**|PUT/DELETE请求正常完成|<<_7df42878154cc2753b37c65d4654dea5,Page«Course»>> |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /course/getCoursePageList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "articleAmount" : 0, "basicContent" : "string", "commentCount" : 0, "cover" : "string", "createTime" : "string", "enrolment" : 0, "id" : 0, "name" : "string", "online" : true, "price" : 0.0, "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- ====== 响应 201 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "articleAmount" : 0, "basicContent" : "string", "commentCount" : 0, "cover" : "string", "createTime" : "string", "enrolment" : 0, "id" : 0, "name" : "string", "online" : true, "price" : 0.0, "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- ====== 响应 204 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "articleAmount" : 0, "basicContent" : "string", "commentCount" : 0, "cover" : "string", "createTime" : "string", "enrolment" : 0, "id" : 0, "name" : "string", "online" : true, "price" : 0.0, "updateTime" : "string" } ], "size" : 0, "total" : 0 } ---- [[_getenrolmentlistusingget]] ==== 后端查看报名列表 .... GET /course/getEnrolmentList .... ===== 说明 后端查看报名列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**courseId** + __可选__|courseId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_8457a44897358069075a70a419deb8ca,Page«用户课程»>> |**201**|POST请求正常完成|<<_8457a44897358069075a70a419deb8ca,Page«用户课程»>> |**204**|PUT/DELETE请求正常完成|<<_8457a44897358069075a70a419deb8ca,Page«用户课程»>> |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /course/getEnrolmentList ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "chapterId" : 0, "complete" : true, "courseId" : 0, "cseriesId" : 0, "lastStudyTime" : "string", "schedule" : 0, "userId" : 0 } ], "size" : 0, "total" : 0 } ---- ====== 响应 201 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "chapterId" : 0, "complete" : true, "courseId" : 0, "cseriesId" : 0, "lastStudyTime" : "string", "schedule" : 0, "userId" : 0 } ], "size" : 0, "total" : 0 } ---- ====== 响应 204 [source,json] ---- { "current" : 0, "pages" : 0, "records" : [ { "chapterId" : 0, "complete" : true, "courseId" : 0, "cseriesId" : 0, "lastStudyTime" : "string", "schedule" : 0, "userId" : 0 } ], "size" : 0, "total" : 0 } ---- [[_1c75f8397ecb388ed94ba5588635f841]] === 课程章节单元业务接口 Course Chapter Controller [[_begintostudyusingget]] ==== beginToStudy .... GET /courseChapter/beginToStudy/{courseId} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Header**|**Authorization** + __必填__|Authorization|string |**Path**|**courseId** + __必填__|courseId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/beginToStudy/0 ---- ====== 请求 header [source,json] ---- "string" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ---- [[_continuestudyingusingget]] ==== continueStudying .... GET /courseChapter/continueStudying/{courseId} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Header**|**Authorization** + __必填__|Authorization|string |**Path**|**chapterId** + __必填__|chapterId|integer (int32) |**Path**|**courseId** + __必填__|courseId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/continueStudying/0 ---- ====== 请求 header [source,json] ---- "string" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ---- [[_deleteusingdelete_2]] ==== 删除课程章节单元 .... DELETE /courseChapter/delete .... ===== 说明 删除课程章节单元 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**commentId** + __可选__|评论ID|ref |**Query**|**courseChapterId** + __可选__|courseChapterId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|< string, object > map |**201**|POST请求正常完成|< string, object > map |**204**|PUT/DELETE请求正常完成|< string, object > map |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/delete ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- ====== 响应 201 [source,json] ---- "object" ---- ====== 响应 204 [source,json] ---- "object" ---- [[_editusingput_1]] ==== 编辑课程章节标题或内容 .... PUT /courseChapter/edit .... ===== 说明 编辑课程章节标题或内容 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**allReferParentIds** + __可选__|上级依次节点ID(用逗号分开)|string |**Query**|**content** + __可选__|课时内容|string |**Query**|**courseId** + __可选__|所属课程id|ref |**Query**|**id** + __可选__|课程章节ID|integer (int32) |**Query**|**title** + __可选__|章节单元标题|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|< string, object > map |**201**|POST请求正常完成|< string, object > map |**204**|PUT/DELETE请求正常完成|< string, object > map |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/edit ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- ====== 响应 201 [source,json] ---- "object" ---- ====== 响应 204 [source,json] ---- "object" ---- [[_findusingget_1]] ==== find .... GET /courseChapter/get/{id} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Path**|**id** + __必填__|id|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/get/0 ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ---- [[_getcoursechapterlistusingget]] ==== 根据courseId查询课程章节单元列表 .... GET /courseChapter/getCourseChapterList .... ===== 说明 根据courseId查询课程章节单元列表 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**_index** + __可选__|分页起始偏移量|ref |**Query**|**_size** + __可选__|返回条数|ref |**Query**|**allReferParentIds** + __可选__|上级依次节点ID(用逗号分开)|string |**Query**|**content** + __可选__|课时内容|string |**Query**|**courseId** + __必填__|所属课程ID|string |**Query**|**id** + __可选__|课程章节ID|integer (int32) |**Query**|**title** + __可选__|章节单元标题|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|< <<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> > array |**201**|POST请求正常完成|< <<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> > array |**204**|PUT/DELETE请求正常完成|< <<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> > array |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/getCourseChapterList?courseId=string ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- [ { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ] ---- ====== 响应 201 [source,json] ---- [ { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ] ---- ====== 响应 204 [source,json] ---- [ { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ] ---- [[_saveusingpost_1]] ==== 增加课程章节 .... POST /courseChapter/save .... ===== 说明 增加课程章节 ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**allReferParentIds** + __可选__|所有相关联的父级ID|string |**Query**|**content** + __可选__|课时内容|string |**Query**|**courseId** + __必填__|所属课程id|ref |**Query**|**id** + __可选__|课程章节ID|integer (int32) |**Query**|**title** + __可选__|章节单元标题|string |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|< string, object > map |**201**|POST请求正常完成|< string, object > map |**204**|PUT/DELETE请求正常完成|< string, object > map |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/save?courseId=ref ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- "object" ---- ====== 响应 201 [source,json] ---- "object" ---- ====== 响应 204 [source,json] ---- "object" ---- [[_updatesortorderusingput]] ==== updateSortorder .... PUT /courseChapter/updateSortorder .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Query**|**moveType** + __可选__|moveType|string |**Query**|**sourceId** + __可选__|sourceId|integer (int32) |**Query**|**targetId** + __可选__|targetId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|无内容 |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 消耗 * `application/json` ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/updateSortorder ---- [[_viewnextusingget]] ==== viewNext .... GET /courseChapter/viewNext/{courseId}/{chapterId} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Header**|**Authorization** + __必填__|Authorization|string |**Path**|**chapterId** + __必填__|chapterId|integer (int32) |**Path**|**courseId** + __必填__|courseId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/viewNext/0/0 ---- ====== 请求 header [source,json] ---- "string" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ---- [[_viewprevusingget]] ==== viewPrev .... GET /courseChapter/viewPrev/{courseId}/{chapterId} .... ===== 参数 [options="header", cols=".^2a,.^3a,.^9a,.^4a"] |=== |类型|名称|说明|类型 |**Header**|**Authorization** + __必填__|Authorization|string |**Path**|**chapterId** + __必填__|chapterId|integer (int32) |**Path**|**courseId** + __必填__|courseId|integer (int32) |=== ===== 响应 [options="header", cols=".^2a,.^14a,.^4a"] |=== |HTTP代码|说明|类型 |**200**|GET请求正常完成|<<_09ed21722d3095e301701ed2000eecb3,课程章节单元>> |**201**|POST请求正常完成|无内容 |**204**|PUT/DELETE请求正常完成|无内容 |**400**|请求中参数有问题，或不能满足请求|无内容 |**401**|未授权客户机访问数据或Token过期|无内容 |**500**|服务器出现异常|无内容 |=== ===== 生成 * `\*/*` ===== 安全 [options="header", cols=".^3a,.^4a,.^13a"] |=== |类型|名称|作用域 |**apiKey**|**<<_bearertoken,BearerToken>>**|global |=== ===== HTTP请求示例 ====== 请求 path ---- /courseChapter/viewPrev/0/0 ---- ====== 请求 header [source,json] ---- "string" ---- ===== HTTP响应示例 ====== 响应 200 [source,json] ---- { "allReferParentIds" : "string", "content" : "string", "courseId" : 0, "id" : 0, "title" : "string" } ---- [[_definitions]] == 定义 [[_about]] === About [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**content** + __可选__|内容 + **样例** : `"string"`|string |**createTime** + __可选__|创建时间 + **样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**updateTime** + __可选__|更新时间 + **样例** : `"string"`|string (date-time) |=== [[_comment]] === Comment [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**childrenCount** + __可选__|子评论数量 + **样例** : `0`|integer (int32) |**content** + __可选__|评论内容 + **样例** : `"string"`|string |**contentId** + __可选__|所属内容 + **样例** : `0`|integer (int32) |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**forumId** + __可选__|所属板块 + **样例** : `0`|integer (int32) |**id** + __可选__|**样例** : `0`|integer (int32) |**mentionedComment** + __可选__|**样例** : `"string"`|string |**parentId** + __可选__|父评论id + **样例** : `0`|integer (int32) |**stars** + __可选__|点赞量 + **样例** : `0`|integer (int32) |**timeRange** + __可选__|**样例** : `"string"`|string |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |**userId** + __可选__|评论人ID + **样例** : `0`|integer (int32) |=== [[_content]] === Content [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**atTop** + __可选__|是否置顶 true:1 false:0 + **样例** : `true`|boolean |**banner** + __可选__|内容头图 + **样例** : `"string"`|string |**clicks** + __可选__|点击量 + **样例** : `0`|integer (int32) |**commentCount** + __可选__|评论数量 + **样例** : `0`|integer (int32) |**content** + __可选__|内容 + **样例** : `"string"`|string |**contentType** + __可选__|内容类型 + **样例** : `0`|integer (int32) |**cover** + __可选__|列表中展示图片 + **样例** : `"string"`|string |**createTime** + __可选__|创建时间 + **样例** : `"string"`|string (date-time) |**favourites** + __可选__|收藏量 + **样例** : `0`|integer (int32) |**forumId** + __可选__|板块id + **样例** : `0`|integer (int32) |**forwardingCount** + __可选__|转发量 + **样例** : `0`|integer (int32) |**hasRead** + __可选__|已读 true:1 false:0 + **样例** : `true`|boolean |**hasVote** + __可选__|是否插入投票 true:1 false:0 + **样例** : `0`|integer (int32) |**id** + __可选__|内容id + **样例** : `0`|integer (int32) |**sources** + __可选__|来源 + **样例** : `"string"`|string |**stars** + __可选__|点赞量 + **样例** : `0`|integer (int32) |**styleId** + __可选__|背景风格id + **样例** : `0`|integer (int32) |**subtitle** + __可选__|子标题 + **样例** : `"string"`|string |**thumbnail** + __可选__|缩略图 + **样例** : `"string"`|string |**timeRange** + __可选__|**样例** : `"string"`|string |**title** + __可选__|内容表题 + **样例** : `"string"`|string |**updateTime** + __可选__|更新时间 + **样例** : `"string"`|string (date-time) |**videoUrl** + __可选__|视频链接 + **样例** : `"string"`|string |**voteId** + __可选__|**样例** : `0`|integer (int32) |=== [[_course]] === Course [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**articleAmount** + __可选__|总课时 + **样例** : `0`|integer (int32) |**basicContent** + __可选__|基础信息 + **样例** : `"string"`|string |**commentCount** + __可选__|评论数量 + **样例** : `0`|integer (int32) |**cover** + __可选__|封面 + **样例** : `"string"`|string |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**enrolment** + __可选__|报名人数 + **样例** : `0`|integer (int32) |**id** + __可选__|课程ID + **样例** : `0`|integer (int32) |**name** + __可选__|课程名称 + **样例** : `"string"`|string |**online** + __可选__|课程状态 + **样例** : `true`|boolean |**price** + __可选__|课程价格(默认是0) + **样例** : `0.0`|number |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |=== [[_coursecomment]] === CourseComment [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**childrenCount** + __可选__|**样例** : `0`|integer (int32) |**content** + __可选__|**样例** : `"string"`|string |**courseId** + __可选__|**样例** : `0`|integer (int32) |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**cseriesId** + __可选__|**样例** : `0`|integer (int32) |**id** + __可选__|**样例** : `0`|integer (int32) |**mentionedCourseComment** + __可选__|**样例** : `"string"`|string |**parentId** + __可选__|**样例** : `0`|integer (int32) |**stars** + __可选__|**样例** : `0`|integer (int32) |**timeRange** + __可选__|**样例** : `"string"`|string |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |**userId** + __可选__|**样例** : `0`|integer (int32) |=== [[_event]] === Event [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**city** + __可选__|比赛地点 城市 例：1北京 + **样例** : `"string"`|string |**content** + __可选__|编辑器内容 + **样例** : `"string"`|string |**country** + __可选__|比赛地点 国家 例：0中国 + **样例** : `"string"`|string |**createTime** + __可选__|创建时间 + **样例** : `"string"`|string (date-time) |**endTime** + __可选__|结束时间 + **样例** : `"string"`|string (date-time) |**event** + __可选__|是否展示倒计时事件 1:true 0:false + **样例** : `true`|boolean |**headMap** + __可选__|头图 + **样例** : `"string"`|string |**id** + __可选__|事件ID + **样例** : `0`|integer (int32) |**linkAddress** + __可选__|链接地址 + **样例** : `"string"`|string |**logo** + __可选__|系列赛logo + **样例** : `"string"`|string |**logoName** + __可选__|系列赛名称 + **样例** : `"string"`|string |**match** + __可选__|是否为重点赛事 1：true 0:false + **样例** : `true`|boolean |**nationalFlag** + __可选__|国旗 + **样例** : `"string"`|string |**startTime** + __可选__|开始时间 + **样例** : `"string"`|string (date-time) |**title** + __可选__|事件标题 + **样例** : `"string"`|string |**type** + __可选__|比赛类型 + **样例** : `"string"`|string |=== [[_forum]] === Forum [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**banner** + __可选__|板块头图 + **样例** : `"string"`|string |**createTime** + __可选__|创建时间 + **样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**logo** + __可选__|板块列表中的图 + **样例** : `"string"`|string |**name** + __可选__|板块名称 + **样例** : `"string"`|string |**parentId** + __可选__|父级id + **样例** : `0`|integer (int32) |**sortorder** + __可选__|排序 + **样例** : `0`|integer (int32) |**summary** + __可选__|摘要 + **样例** : `"string"`|string |**updateTime** + __可选__|更新时间 + **样例** : `"string"`|string (date-time) |=== [[_fe5293b8150fdf81185174959d77609c]] === Map«string,string» __类型__ : < string, string > map [[_mssmsauth]] === MsSmsAuth [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**code** + __可选__|**样例** : `"string"`|string |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**iphone** + __可选__|**样例** : `"string"`|string |**remark** + __可选__|**样例** : `"string"`|string |**type** + __可选__|**样例** : `"string"`|string |=== [[_mssyslog]] === MsSysLog [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**content** + __可选__|**样例** : `"string"`|string |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**ip** + __可选__|**样例** : `"string"`|string |**loginName** + __可选__|**样例** : `"string"`|string |**operation** + __可选__|**样例** : `"string"`|string |=== [[_navigation]] === Navigation [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**createTime** + __可选__|创建时间 + **样例** : `"string"`|string (date-time) |**id** + __可选__|Herder管理ID + **样例** : `0`|integer (int32) |**link** + __可选__|超链接 + **样例** : `"string"`|string |**logo** + __可选__|图片 + **样例** : `"string"`|string |**navType** + __可选__|**样例** : `0`|integer (int32) |**sortorder** + __可选__|排序方式 + **样例** : `0`|integer (int32) |**title** + __可选__|标题 + **样例** : `"string"`|string |**updateTime** + __可选__|更新时间 + **样例** : `"string"`|string (date-time) |=== [[_news]] === News [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**approved** + __可选__|**样例** : `0`|integer (int32) |**author** + __可选__|**样例** : `"string"`|string |**channelId** + __可选__|**样例** : `"string"`|string |**clicks** + __可选__|**样例** : `0`|integer (int32) |**commentCount** + __可选__|**样例** : `0`|integer (int32) |**commentsNum** + __可选__|**样例** : `0`|integer (int32) |**content** + __可选__|**样例** : `"string"`|string |**cover** + __可选__|**样例** : `"string"`|string |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**endTime** + __可选__|**样例** : `"string"`|string (date-time) |**favorite** + __可选__|**样例** : `true`|boolean |**id** + __可选__|**样例** : `0`|integer (int32) |**newsSource** + __可选__|**样例** : `"string"`|string |**realname** + __可选__|**样例** : `"string"`|string |**signUpNum** + __可选__|**样例** : `0`|integer (int32) |**signUpTotlNum** + __可选__|**样例** : `0`|integer (int32) |**slidesId** + __可选__|**样例** : `0`|integer (int32) |**startTime** + __可选__|**样例** : `"string"`|string (date-time) |**tag** + __可选__|**样例** : `"string"`|string |**thumbnail** + __可选__|**样例** : `"string"`|string |**thumbsUp** + __可选__|**样例** : `0`|integer (int32) |**title** + __可选__|**样例** : `"string"`|string |**type** + __可选__|**样例** : `0`|integer (int32) |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |**videoType** + __可选__|**样例** : `0`|integer (int32) |**videoUrl** + __可选__|**样例** : `"string"`|string |**videostateId** + __可选__|**样例** : `0`|integer (int32) |=== [[_34dcacff9872819d750cb2de98f38141]] === Page«About» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_about>>" ]`|< <<_about,About>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_052e9a21b4156f3087f25bdae679f2ea]] === Page«Comment» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_comment>>" ]`|< <<_comment,Comment>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_17ff3e2cd73f8dc03e4694de7a1250a4]] === Page«Content» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_content>>" ]`|< <<_content,Content>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_02278037ab4d834a188ebd132462e29f]] === Page«CourseComment» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_coursecomment>>" ]`|< <<_coursecomment,CourseComment>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_7df42878154cc2753b37c65d4654dea5]] === Page«Course» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_course>>" ]`|< <<_course,Course>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_f8833f942faff206036106eeedb317ed]] === Page«Event» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_event>>" ]`|< <<_event,Event>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_d2128bca6950112f6d84c39fc770dbe4]] === Page«Forum» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_forum>>" ]`|< <<_forum,Forum>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_8b78d64bed117e8c4c50c4d6edc76544]] === Page«MsSmsAuth» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_mssmsauth>>" ]`|< <<_mssmsauth,MsSmsAuth>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_d626f0b9145010a8973821b1d3aeccfa]] === Page«MsSysLog» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_mssyslog>>" ]`|< <<_mssyslog,MsSysLog>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_767dfddd4ae8b55c1bb050ae9b91b73b]] === Page«Navigation» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_navigation>>" ]`|< <<_navigation,Navigation>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_edff568e39ff129ea3f6a5cf8adf6adf]] === Page«News» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_news>>" ]`|< <<_news,News>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_b35c7f1cd4f3c4caa27ffd91ec94f2b8]] === Page«Permission» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_permission>>" ]`|< <<_permission,Permission>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_0fe60ae86270844597a23b3864495439]] === Page«RankingClassify» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_rankingclassify>>" ]`|< <<_rankingclassify,RankingClassify>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_418738a9a7914b43b88074d53bb74d81]] === Page«Role» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_role>>" ]`|< <<_role,Role>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_c333954711cf896dc054efb257570d23]] === Page«UserComment» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_usercomment>>" ]`|< <<_usercomment,UserComment>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_d7a0dcbd107b55ce300a54f6c5edc271]] === Page«UserFavorites» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_userfavorites>>" ]`|< <<_userfavorites,UserFavorites>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_96e7f3d545e5ff9453abf586bac52683]] === Page«UserStar» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_userstar>>" ]`|< <<_userstar,UserStar>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_e74dd976185b63fab3d0c002ca14d581]] === Page«User» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_user>>" ]`|< <<_user,User>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_d0876c5d78b163a52e397f1537844bfc]] === Page«Vote» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_vote>>" ]`|< <<_vote,Vote>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_8457a44897358069075a70a419deb8ca]] === Page«用户课程» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_376b2dc02303377c1d2cf28eeb91b4f1>>" ]`|< <<_376b2dc02303377c1d2cf28eeb91b4f1,用户课程>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_3f99111dc5e4b2b3863260fc6ec717e3]] === Page«课程公告» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_c579e2d002cf09f3922fca8d061f9400>>" ]`|< <<_c579e2d002cf09f3922fca8d061f9400,课程公告>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_805ef2039d8b2bf4abf1c68ce2cccb84]] === Page«课程系列» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_4a9df568c3f33166a1d37ab929a40fc3>>" ]`|< <<_4a9df568c3f33166a1d37ab929a40fc3,课程系列>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_43e7db15c6931e6b836b815d19bb2b83]] === Page«轮播图» [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**current** + __可选__|**样例** : `0`|integer (int32) |**pages** + __可选__|**样例** : `0`|integer (int64) |**records** + __可选__|**样例** : `[ "<<_0c0180cb06a322199a67f10d4ec41cd5>>" ]`|< <<_0c0180cb06a322199a67f10d4ec41cd5,轮播图>> > array |**size** + __可选__|**样例** : `0`|integer (int32) |**total** + __可选__|**样例** : `0`|integer (int64) |=== [[_permission]] === Permission [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**name** + __可选__|**样例** : `"string"`|string |**pid** + __可选__|**样例** : `0`|integer (int32) |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |**url** + __可选__|**样例** : `"string"`|string |=== [[_picuploadresult]] === PicUploadResult [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**height** + __可选__|**样例** : `"string"`|string |**url** + __可选__|**样例** : `"string"`|string |**width** + __可选__|**样例** : `"string"`|string |=== [[_rankingclassify]] === RankingClassify [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**isTopShow** + __可选__|是否首页显示 1是 0否 + **样例** : `0`|integer (int32) |**rankClassifyName** + __可选__|排行分类名称 + **样例** : `"string"`|string |**sortOrder** + __可选__|**样例** : `0`|integer (int32) |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |=== [[_role]] === Role [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**alias** + __可选__|**样例** : `"string"`|string |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**explain** + __可选__|**样例** : `"string"`|string |**flag** + __可选__|**样例** : `"string"`|string |**id** + __可选__|**样例** : `0`|integer (int32) |**name** + __可选__|**样例** : `"string"`|string |**rolePermissionList** + __可选__|**样例** : `[ "<<_rolepermission>>" ]`|< <<_rolepermission,RolePermission>> > array |**status** + __可选__|**样例** : `"string"`|string |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |=== [[_rolepermission]] === RolePermission [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**pid** + __可选__|**样例** : `0`|integer (int32) |**rid** + __可选__|**样例** : `0`|integer (int32) |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |=== [[_user]] === User [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**authCacheKey** + __可选__|**样例** : `"string"`|string |**avatar** + __可选__|**样例** : `"string"`|string |**birthday** + __可选__|**样例** : `"string"`|string (date-time) |**certificatesId** + __可选__|**样例** : `"string"`|string |**city** + __可选__|**样例** : `"string"`|string |**clubName** + __可选__|**样例** : `"string"`|string |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**district** + __可选__|**样例** : `"string"`|string |**email** + __可选__|**样例** : `"string"`|string |**enabled** + __可选__|**样例** : `0`|integer (int32) |**id** + __可选__|**样例** : `0`|integer (int32) |**introduction** + __可选__|**样例** : `"string"`|string |**isLive** + __可选__|**样例** : `0`|integer (int32) |**jwtToken** + __可选__|**样例** : `"string"`|string |**lastLoginIp** + __可选__|**样例** : `"string"`|string |**lastLoginTime** + __可选__|**样例** : `"string"`|string (date-time) |**logo** + __可选__|**样例** : `"string"`|string |**managerName** + __可选__|**样例** : `"string"`|string |**mobile** + __可选__|**样例** : `"string"`|string |**openId** + __可选__|**样例** : `"string"`|string |**password** + __可选__|**样例** : `"string"`|string |**passwordHash** + __可选__|**模式** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"` + **样例** : `"string"`|string (byte) |**passwordSalt** + __可选__|**模式** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"` + **样例** : `"string"`|string (byte) |**post** + __可选__|**样例** : `"string"`|string |**province** + __可选__|**样例** : `"string"`|string |**realname** + __可选__|**样例** : `"string"`|string |**registIp** + __可选__|**样例** : `"string"`|string |**registTime** + __可选__|**样例** : `"string"`|string (date-time) |**roleId** + __可选__|**样例** : `0`|integer (int32) |**sex** + __可选__|**样例** : `0`|integer (int32) |**totalLoginCounts** + __可选__|**样例** : `0`|integer (int32) |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |**userType** + __可选__|**样例** : `0`|integer (int32) |**username** + __可选__|**样例** : `"string"`|string |=== [[_usercomment]] === UserComment [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**commentId** + __可选__|**样例** : `0`|integer (int32) |**contentId** + __可选__|**样例** : `0`|integer (int32) |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**id** + __可选__|**样例** : `0`|integer (int32) |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |**userId** + __可选__|**样例** : `0`|integer (int32) |=== [[_userfavorites]] === UserFavorites [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**contentId** + __可选__|收藏内容id + **样例** : `0`|integer (int32) |**id** + __可选__|收藏id + **样例** : `0`|integer (int32) |**userId** + __可选__|收藏人用户id + **样例** : `0`|integer (int32) |=== [[_userstar]] === UserStar [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**content** + __可选__|**样例** : <<_content>>|<<_content,Content>> |**contentId** + __可选__|点赞内容id + **样例** : `0`|integer (int32) |**createTime** + __可选__|创建时间 + **样例** : `"string"`|string (date-time) |**id** + __可选__|点赞id + **样例** : `0`|integer (int32) |**updateTime** + __可选__|更新时间 + **样例** : `"string"`|string (date-time) |**userId** + __可选__|用户id + **样例** : `0`|integer (int32) |=== [[_vote]] === Vote [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**closed** + __可选__|是否已结束 1:true 0:false + **样例** : `true`|boolean |**endTime** + __可选__|结束时间 + **样例** : `"string"`|string (date-time) |**id** + __可选__|投票ID + **样例** : `0`|integer (int32) |**isUsed** + __可选__|是否被使用 1：未使用 0：已被使用 + **样例** : `"string"`|string |**multiSelected** + __可选__|是否多选标志 1:true多选 0:false单选 + **样例** : `true`|boolean |**startTime** + __可选__|开始时间 + **样例** : `"string"`|string (date-time) |**title** + __可选__|**样例** : `"string"`|string |**totalCount** + __可选__|投票总数 + **样例** : `0`|integer (int32) |=== [[_376b2dc02303377c1d2cf28eeb91b4f1]] === 用户课程 [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**chapterId** + __可选__|课程文章ID + **样例** : `0`|integer (int32) |**complete** + __可选__|是否已完成学习 + **样例** : `true`|boolean |**courseId** + __可选__|课程ID + **样例** : `0`|integer (int32) |**cseriesId** + __可选__|课程系列ID + **样例** : `0`|integer (int32) |**lastStudyTime** + __可选__|上次学习时间 + **样例** : `"string"`|string (date-time) |**schedule** + __可选__|学习进度 + **样例** : `0`|integer (int32) |**userId** + __可选__|用户ID + **样例** : `0`|integer (int32) |=== [[_12a470c08b63dc040012f9e34a72737e]] === 课程-课程系列多对多关联 [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**courseId** + __可选__|课程ID + **样例** : `0`|integer (int32) |**seriesId** + __可选__|课程系列ID + **样例** : `0`|integer (int32) |=== [[_c579e2d002cf09f3922fca8d061f9400]] === 课程公告 [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**content** + __可选__|课程公告内容 + **样例** : `"string"`|string |**cover** + __可选__|课程公告封面图 + **样例** : `"string"`|string |**cseriesId** + __可选__|课程系列ID + **样例** : `0`|integer (int32) |**id** + __可选__|课程公告ID + **样例** : `0`|integer (int32) |**title** + __可选__|课程公告标题 + **样例** : `"string"`|string |=== [[_09ed21722d3095e301701ed2000eecb3]] === 课程章节单元 [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**allReferParentIds** + __可选__|上级依次节点ID(用逗号分开) + **样例** : `"string"`|string |**content** + __可选__|课时内容 + **样例** : `"string"`|string |**courseId** + __可选__|课程ID + **样例** : `0`|integer (int32) |**id** + __可选__|课程章节ID + **样例** : `0`|integer (int32) |**title** + __可选__|章节单元标题 + **样例** : `"string"`|string |=== [[_4a9df568c3f33166a1d37ab929a40fc3]] === 课程系列 [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**background** + __可选__|课程系列背景图 + **样例** : `"string"`|string |**courseAmont** + __可选__|课程数量 + **样例** : `0`|integer (int32) |**id** + __可选__|课程系列ID + **样例** : `0`|integer (int32) |**logo** + __可选__|课程系列LOGO + **样例** : `"string"`|string |**name** + __可选__|课程系列名称 + **样例** : `"string"`|string |=== [[_0c0180cb06a322199a67f10d4ec41cd5]] === 轮播图 [options="header", cols=".^3a,.^11a,.^4a"] |=== |名称|说明|类型 |**banner** + __可选__|封面图 + **样例** : `"string"`|string |**createTime** + __可选__|**样例** : `"string"`|string (date-time) |**id** + __可选__|轮播图ID + **样例** : `0`|integer (int32) |**link** + __可选__|超链接 + **样例** : `"https://www.baidu.com/"`|string |**navType** + __可选__|**样例** : `0`|integer (int32) |**sortorder** + __可选__|**样例** : `0`|integer (int32) |**title** + __可选__|标题 + **样例** : `"string"`|string |**updateTime** + __可选__|**样例** : `"string"`|string (date-time) |**videoCover** + __可选__|**样例** : `"string"`|string |=== [[_securityscheme]] == 安全 [[_bearertoken]] === BearerToken [%hardbreaks] __类型__ : apiKey __名称__ : Authorization __在__ : HEADER