1
0
mirror of https://gitee.com/bookshelfplus/bookshelfplus synced 2025-09-01 22:53:29 +08:00
Code Issues Projects Releases Wiki Activity GitHub Gitee

不重要的一些小调整(主要是部分Api权限的调整以及Api文档调整)

This commit is contained in:
2022-04-15 21:56:37 +08:00
parent 5c1a935697
commit 9e11207438
7 changed files with 144 additions and 50 deletions

View File

@@ -5,7 +5,7 @@
请按 F12 查看详情
</p>
<script>
postRequest('/debug/status', { token: localStorageUtils.getToken() })
postRequest('/system/status', { token: localStorageUtils.getToken() })
.then(function (response) {
var axiosData = response.data;
var status = axiosData.status;

View File

@@ -23,7 +23,7 @@ __域名__ : localhost:8090
* 文件管理 : File Controller
* 用户操作 : User Controller
* 第三方登录 : Third Party Controller
* 系统调试接口 : Debug Controller
* 系统调试接口 : System Controller
* 网站后台状态检测 : Status Controller
@@ -663,7 +663,7 @@ File Controller
[[_cosusingpost]]
==== 创建腾讯云 COS 预授权 URL
==== 【用户|管理员】创建腾讯云 COS 预授权 URL
....
POST /api/file/cos/{httpMethod}
....
@@ -678,8 +678,18 @@ POST /api/file/cos/{httpMethod}
__必填__|httpMethod|string
|**FormData**|**expireMinute** +
__可选__||integer (int32)
|**FormData**|**fileExt** +
__可选__||string
|**FormData**|**fileId** +
__可选__||integer (int32)
|**FormData**|**fileName** +
__可选__||string
|**FormData**|**fileSha1** +
__可选__||string
|**FormData**|**fileSize** +
__可选__||integer (int64)
|**FormData**|**fileType** +
__可选__||string
|**FormData**|**token** +
__可选__||string
|===
@@ -736,7 +746,7 @@ __可选__||string
[[_listusingpost]]
==== 查询文件列表
==== 【管理员】查询文件列表
....
POST /api/file/list
....
@@ -807,7 +817,7 @@ __可选__|string
[[_objectlistusingpost]]
==== 查询文件对象列表
==== 【管理员】查询文件对象列表
....
POST /api/file/object/list
....
@@ -877,15 +887,15 @@ __可选__|string
----
[[_cosfinishuploadusingpost]]
==== cosFinishUpload
[[_coscheckfilestatususingpost]]
==== 【COS】腾讯云 COS 文件上传成功回调
....
POST /api/file/upload/finish-upload
POST /api/file/upload/cos-check-file-state
....
===== 说明
客户端向腾讯云 COS 存储桶上传文件完毕
客户端向腾讯云 COS 存储桶上传文件完毕,有云函数触发此请求
===== 参数
@@ -893,9 +903,9 @@ POST /api/file/upload/finish-upload
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**fileName** +
|**FormData**|**context** +
__可选__|string
|**FormData**|**urlGUID** +
|**FormData**|**event** +
__可选__|string
|===
@@ -927,7 +937,7 @@ __可选__|string
====== 请求 path
----
/api/file/upload/finish-upload
/api/file/upload/cos-check-file-state
----
@@ -956,7 +966,7 @@ User Controller
[[_cancelaccountusingpost]]
==== 账号注销
==== 【用户】账号注销
....
POST /api/user/cancelAccount
....
@@ -1173,7 +1183,7 @@ __可选__|string
[[_logoutusingpost]]
==== 用户登出
==== 【用户|管理员】用户登出
....
POST /api/user/logout
....
@@ -1394,7 +1404,7 @@ __可选__|token|string
[[_getbindingstatususingget]]
==== 获取用户已绑定的第三方平台
==== 【用户|管理员】获取用户已绑定的第三方平台
....
GET /api/third-party/getBindingStatus
....
@@ -1510,7 +1520,7 @@ __必填__|platform|string
[[_unbindthirdpartaccountusingpost]]
==== 取消第三方平台绑定
==== 【用户|管理员】取消第三方平台绑定
....
POST /api/third-party/withdrawThirdPartyBings
....
@@ -1584,13 +1594,13 @@ __可选__|string
[[_aca0f16a4237edba915fe70c9b07871c]]
=== 系统调试接口
Debug Controller
System Controller
[[_statususingpost]]
==== 获取系统配置
==== 【管理员】获取系统配置
....
POST /api/debug/status
POST /api/system/status
....
@@ -1635,7 +1645,7 @@ __可选__|string
====== 请求 path
----
/api/debug/status
/api/system/status
----

View File

@@ -587,7 +587,7 @@ table.CodeRay td.code>pre{padding:0}
<p>第三方登录 : Third Party Controller</p>
</li>
<li>
<p>系统调试接口 : Debug Controller</p>
<p>系统调试接口 : System Controller</p>
</li>
<li>
<p>网站后台状态检测 : Status Controller</p>
@@ -2277,7 +2277,7 @@ table.CodeRay td.code>pre{padding:0}
<p>File Controller</p>
</div>
<div class="sect3">
<h4 id="_cosusingpost">2.3.1. 创建腾讯云 COS 预授权 URL</h4>
<h4 id="_cosusingpost">2.3.1. 【用户|管理员】创建腾讯云 COS 预授权 URL</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/file/cos/{httpMethod}</pre>
@@ -2334,6 +2334,32 @@ table.CodeRay td.code>pre{padding:0}
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>fileExt</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>string</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>fileId</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>integer (int32)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>fileName</strong><br>
<em>可选</em></p>
</div></div></td>
@@ -2347,6 +2373,45 @@ table.CodeRay td.code>pre{padding:0}
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>fileSha1</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>string</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>fileSize</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>integer (int64)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>fileType</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>string</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>token</strong><br>
<em>可选</em></p>
</div></div></td>
@@ -2487,7 +2552,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
<h4 id="_listusingpost">2.3.2. 查询文件列表</h4>
<h4 id="_listusingpost">2.3.2. 【管理员】查询文件列表</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/file/list</pre>
@@ -2659,7 +2724,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
<h4 id="_objectlistusingpost">2.3.3. 查询文件对象列表</h4>
<h4 id="_objectlistusingpost">2.3.3. 【管理员】查询文件对象列表</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/file/object/list</pre>
@@ -2831,16 +2896,16 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
<h4 id="_cosfinishuploadusingpost">2.3.4. cosFinishUpload</h4>
<h4 id="_coscheckfilestatususingpost">2.3.4. 【COS】腾讯云 COS 文件上传成功回调</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/file/upload/finish-upload</pre>
<pre>POST /api/file/upload/cos-check-file-state</pre>
</div>
</div>
<div class="sect4">
<h5 id="_说明_12">说明</h5>
<div class="paragraph">
<p>客户端向腾讯云 COS 存储桶上传文件完毕</p>
<p>客户端向腾讯云 COS 存储桶上传文件完毕,有云函数触发此请求</p>
</div>
</div>
<div class="sect4">
@@ -2864,7 +2929,7 @@ table.CodeRay td.code>pre{padding:0}
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>fileName</strong><br>
<p><strong>context</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
@@ -2876,7 +2941,7 @@ table.CodeRay td.code>pre{padding:0}
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>urlGUID</strong><br>
<p><strong>event</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
@@ -2986,7 +3051,7 @@ table.CodeRay td.code>pre{padding:0}
<h6 id="_请求_path_13">请求 path</h6>
<div class="listingblock">
<div class="content">
<pre>/api/file/upload/finish-upload</pre>
<pre>/api/file/upload/cos-check-file-state</pre>
</div>
</div>
</div>
@@ -3021,7 +3086,7 @@ table.CodeRay td.code>pre{padding:0}
<p>User Controller</p>
</div>
<div class="sect3">
<h4 id="_cancelaccountusingpost">2.4.1. 账号注销</h4>
<h4 id="_cancelaccountusingpost">2.4.1. 【用户】账号注销</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/user/cancelAccount</pre>
@@ -3561,7 +3626,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
<h4 id="_logoutusingpost">2.4.4. 用户登出</h4>
<h4 id="_logoutusingpost">2.4.4. 【用户|管理员】用户登出</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/user/logout</pre>
@@ -4164,7 +4229,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
<h4 id="_getbindingstatususingget">2.5.2. 获取用户已绑定的第三方平台</h4>
<h4 id="_getbindingstatususingget">2.5.2. 【用户|管理员】获取用户已绑定的第三方平台</h4>
<div class="literalblock">
<div class="content">
<pre>GET /api/third-party/getBindingStatus</pre>
@@ -4460,7 +4525,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
<h4 id="_unbindthirdpartaccountusingpost">2.5.4. 取消第三方平台绑定</h4>
<h4 id="_unbindthirdpartaccountusingpost">2.5.4. 【用户|管理员】取消第三方平台绑定</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/third-party/withdrawThirdPartyBings</pre>
@@ -4647,13 +4712,13 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect2">
<h3 id="_aca0f16a4237edba915fe70c9b07871c">2.6. 系统调试接口</h3>
<div class="paragraph">
<p>Debug Controller</p>
<p>System Controller</p>
</div>
<div class="sect3">
<h4 id="_statususingpost">2.6.1. 获取系统配置</h4>
<h4 id="_statususingpost">2.6.1. 【管理员】获取系统配置</h4>
<div class="literalblock">
<div class="content">
<pre>POST /api/debug/status</pre>
<pre>POST /api/system/status</pre>
</div>
</div>
<div class="sect4">
@@ -4793,7 +4858,7 @@ table.CodeRay td.code>pre{padding:0}
<h6 id="_请求_path_23">请求 path</h6>
<div class="listingblock">
<div class="content">
<pre>/api/debug/status</pre>
<pre>/api/system/status</pre>
</div>
</div>
</div>
@@ -4993,7 +5058,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
<div id="footer">
<div id="footer-text">
Last updated 2022-04-15 15:53:50 SGT
Last updated 2022-04-15 21:52:10 SGT
</div>
</div>
</body>

View File

@@ -53,10 +53,16 @@ public class FileController extends BaseController {
// @Autowired
// ScheduleTaskServiceImpl scheduleTaskService;
@ApiOperation(value = "查询文件列表", notes = "查询文件列表")
@ApiOperation(value = "【管理员】查询文件列表", notes = "查询文件列表")
@RequestMapping(value = "list", method = {RequestMethod.POST}, consumes = {CONTENT_TYPE_FORMED})
@ResponseBody
public CommonReturnType list(@RequestParam(value = "token", required = false) String token) throws InvocationTargetException, IllegalAccessException, BusinessException {
UserModel userModel = userService.getUserByToken(redisTemplate, token);
if (userModel == null || !Objects.equals(userModel.getGroup(), "ADMIN")) {
throw new BusinessException(BusinessErrorCode.OPERATION_NOT_ALLOWED, "非管理员用户无权进行此操作");
}
List<FileModel> fileModels = fileService.list(token);
List<FileVO> fileVOS = new ArrayList<>();
for (FileModel fileModel : fileModels) {
@@ -74,10 +80,16 @@ public class FileController extends BaseController {
return fileVO;
}
@ApiOperation(value = "查询文件对象列表", notes = "查询文件列表")
@ApiOperation(value = "【管理员】查询文件对象列表", notes = "查询文件列表")
@RequestMapping(value = "object/list", method = {RequestMethod.POST}, consumes = {CONTENT_TYPE_FORMED})
@ResponseBody
public CommonReturnType objectList(@RequestParam(value = "token", required = false) String token) throws InvocationTargetException, IllegalAccessException, BusinessException {
UserModel userModel = userService.getUserByToken(redisTemplate, token);
if (userModel == null || !Objects.equals(userModel.getGroup(), "ADMIN")) {
throw new BusinessException(BusinessErrorCode.OPERATION_NOT_ALLOWED, "非管理员用户无权进行此操作");
}
List<FileObjectModel> fileObjectModels = fileObjectService.list(token);
List<FileObjectVO> fileObjectVOS = new ArrayList<>();
for (FileObjectModel fileObjectModel : fileObjectModels) {
@@ -108,7 +120,7 @@ public class FileController extends BaseController {
* @return
* @throws BusinessException
*/
@ApiOperation(value = "创建腾讯云 COS 预授权 URL", notes = "")
@ApiOperation(value = "【用户|管理员】创建腾讯云 COS 预授权 URL", notes = "")
@RequestMapping(value = "/cos/{httpMethod}", method = {RequestMethod.POST}, consumes = {CONTENT_TYPE_FORMED})
@ResponseBody
public CommonReturnType cos(@PathVariable(value = "httpMethod") String httpMethod,
@@ -176,6 +188,13 @@ public class FileController extends BaseController {
return CommonReturnType.create(map);
}
/**
* 腾讯云 COS 文件上传成功回调方法
* @param eventStr
* @param contextStr
* @return
* @throws BusinessException
*/
@ApiOperation(value = "【COS】腾讯云 COS 文件上传成功回调", notes = "客户端向腾讯云 COS 存储桶上传文件完毕,有云函数触发此请求")
@RequestMapping(value = "/upload/cos-check-file-state", method = {RequestMethod.POST}, consumes = {CONTENT_TYPE_FORMED})
@ResponseBody

View File

@@ -18,9 +18,9 @@ import plus.bookshelf.Service.Model.UserModel;
import java.util.Objects;
@Api(tags = "系统调试接口")
@Controller("debug")
@RequestMapping("/debug")
public class DebugController extends BaseController {
@Controller("system")
@RequestMapping("/system")
public class SystemController extends BaseController {
@Autowired
ThirdPartyConfig thirdPartyConfig;
@@ -28,7 +28,7 @@ public class DebugController extends BaseController {
@Autowired
UserServiceImpl userService;
@ApiOperation(value = "获取系统配置", notes = "仅限管理员登录状态下可获取")
@ApiOperation(value = "【管理员】获取系统配置", notes = "仅限管理员登录状态下可获取")
@RequestMapping(value = "status", method = {RequestMethod.POST}, consumes = {CONTENT_TYPE_FORMED})
@ResponseBody
public CommonReturnType status(@RequestParam(value = "token", required = false) String token) throws BusinessException {

View File

@@ -80,7 +80,7 @@ public class ThirdPartyController extends BaseController {
}
}
@ApiOperation(value = "获取用户已绑定的第三方平台", notes = "传入当前登录用户 token ,返回已绑定的第三方平台")
@ApiOperation(value = "【用户|管理员】获取用户已绑定的第三方平台", notes = "传入当前登录用户 token ,返回已绑定的第三方平台")
@RequestMapping(value = "getBindingStatus", method = {RequestMethod.GET})
@ResponseBody
public CommonReturnType getBindingStatus(@RequestParam(value = "token", required = false) String token) throws BusinessException, InvocationTargetException, IllegalAccessException {
@@ -92,7 +92,7 @@ public class ThirdPartyController extends BaseController {
return CommonReturnType.create(bindingPlatformList);
}
@ApiOperation(value = "取消第三方平台绑定", notes = "传入当前登录用户 token 和平台 platform (不区分大小写),返回 bool 值true 为取消绑定成功")
@ApiOperation(value = "【用户|管理员】取消第三方平台绑定", notes = "传入当前登录用户 token 和平台 platform (不区分大小写),返回 bool 值true 为取消绑定成功")
@RequestMapping(value = "withdrawThirdPartyBings", method = {RequestMethod.POST}, consumes = {CONTENT_TYPE_FORMED})
@ResponseBody
public CommonReturnType unbindThirdPartAccount(@RequestParam(value = "token", required = true) String token,

View File

@@ -66,7 +66,7 @@ public class UserController extends BaseController {
return login(username, password);
}
@ApiOperation(value = "用户登出", notes = "用户退出登录")
@ApiOperation(value = "【用户|管理员】用户登出", notes = "用户退出登录")
// @ApiImplicitParams({
// @ApiImplicitParam(name = "token", value = "用户token", required = true, dataType = "String")
// })
@@ -94,7 +94,7 @@ public class UserController extends BaseController {
return CommonReturnType.create(userVO);
}
@ApiOperation(value = "账号注销", notes = "传入用户 token 以及密码明文后台计算密码SHA1值进行注销")
@ApiOperation(value = "【用户】账号注销", notes = "传入用户 token 以及密码明文后台计算密码SHA1值进行注销")
@RequestMapping(value = "cancelAccount", method = {RequestMethod.POST}, consumes = {CONTENT_TYPE_FORMED})
@ResponseBody
public CommonReturnType cancelAccount(@RequestParam(value = "token", required = false) String token,