From dd25573ebce3450d90d0012a30b12a5185bc7310 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期五, 08 七月 2022 15:49:15 +0800
Subject: [PATCH] update 使用 @param 注释替换 @Parameter 注解 fix 修复 token 无法传递 与 无法持久化问题
---
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java | 7
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/PriorityQueueController.java | 28 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/CacheController.java | 32 ++
pom.xml | 5
ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java | 18 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java | 21 +
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java | 30 +-
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysLoginController.java | 5
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/Swagger3DemoController.java | 13
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java | 26 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysUserOnlineController.java | 12
ruoyi-generator/src/main/resources/vm/java/controller.java.vm | 14
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestExcelController.java | 42 +-
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java | 37 ++
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysUserController.java | 42 ++-
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestBatchController.java | 5
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java | 27 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysMenuController.java | 15
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java | 3
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java | 17
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java | 18 +
ruoyi-admin/src/main/resources/application.yml | 9
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java | 2
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java | 19
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java | 2
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java | 33 +-
ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java | 7
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java | 17 +
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/SmsController.java | 21 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDeptController.java | 19 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java | 12
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisRateLimiterController.java | 2
ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysOperlogController.java | 14 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRegisterController.java | 5
ruoyi-admin/src/main/java/com/ruoyi/web/controller/common/CaptchaController.java | 8
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysProfileController.java | 28 +-
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java | 33 +-
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisPubSubController.java | 18 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysLogininforController.java | 14 +
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java | 11
40 files changed, 464 insertions(+), 227 deletions(-)
diff --git a/pom.xml b/pom.xml
index 8d9a17f..4f59219 100644
--- a/pom.xml
+++ b/pom.xml
@@ -343,6 +343,11 @@
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</path>
+ <path>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-configuration-processor</artifactId>
+ <version>${spring-boot.version}</version>
+ </path>
</annotationProcessorPaths>
</configuration>
</plugin>
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/common/CaptchaController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/common/CaptchaController.java
index c80315f..f2279db 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/common/CaptchaController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/common/CaptchaController.java
@@ -19,7 +19,6 @@
import com.ruoyi.sms.core.SmsTemplate;
import com.ruoyi.sms.entity.SmsResult;
import com.ruoyi.system.service.ISysConfigService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
@@ -40,7 +39,7 @@
@Anonymous
@Slf4j
@Validated
-@Tag(name ="楠岃瘉鐮佹搷浣滃鐞�", description = "楠岃瘉鐮佺鐞�")
+@Tag(name = "楠岃瘉鐮佹搷浣滃鐞�", description = "楠岃瘉鐮佺鐞�")
@RequiredArgsConstructor
@RestController
public class CaptchaController {
@@ -51,10 +50,11 @@
/**
* 鐭俊楠岃瘉鐮�
+ *
+ * @param phonenumber 鐢ㄦ埛鎵嬫満鍙�
*/
@GetMapping("/captchaSms")
- public R<Void> smsCaptcha(@Parameter(name = "鐢ㄦ埛鎵嬫満鍙�")
- @NotBlank(message = "{user.phonenumber.not.blank}")
+ public R<Void> smsCaptcha(@NotBlank(message = "{user.phonenumber.not.blank}")
String phonenumber) {
if (smsProperties.getEnabled()) {
R.fail("褰撳墠绯荤粺娌℃湁寮�鍚煭淇″姛鑳斤紒");
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/CacheController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/CacheController.java
index b394412..849d7c3 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/CacheController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/CacheController.java
@@ -19,7 +19,7 @@
*
* @author Lion Li
*/
-@Tag(name ="缂撳瓨鐩戞帶", description = "缂撳瓨鐩戞帶绠＄悊")
+@Tag(name = "缂撳瓨鐩戞帶", description = "缂撳瓨鐩戞帶绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/monitor/cache")
@@ -40,6 +40,9 @@
CACHES.add(new SysCache(CacheConstants.RATE_LIMIT_KEY, "闄愭祦澶勭悊"));
}
+ /**
+ * 鑾峰彇缂撳瓨鐩戞帶鍒楄〃
+ */
@SaCheckPermission("monitor:cache:list")
@GetMapping()
public R<Map<String, Object>> getInfo() throws Exception {
@@ -65,12 +68,20 @@
return R.ok(result);
}
+ /**
+ * 鑾峰彇缂撳瓨鐩戞帶缂撳瓨鍚嶅垪琛�
+ */
@SaCheckPermission("monitor:cache:list")
@GetMapping("/getNames")
public R<List<SysCache>> cache() {
return R.ok(CACHES);
}
+ /**
+ * 鑾峰彇缂撳瓨鐩戞帶Key鍒楄〃
+ *
+ * @param cacheName 缂撳瓨鍚�
+ */
@SaCheckPermission("monitor:cache:list")
@GetMapping("/getKeys/{cacheName}")
public R<Set<String>> getCacheKeys(@PathVariable String cacheName) {
@@ -78,6 +89,12 @@
return R.ok(cacheKyes);
}
+ /**
+ * 鑾峰彇缂撳瓨鐩戞帶缂撳瓨鍊艰鎯�
+ *
+ * @param cacheName 缂撳瓨鍚�
+ * @param cacheKey 缂撳瓨key
+ */
@SaCheckPermission("monitor:cache:list")
@GetMapping("/getValue/{cacheName}/{cacheKey}")
public R<SysCache> getCacheValue(@PathVariable String cacheName, @PathVariable String cacheKey) {
@@ -86,6 +103,11 @@
return R.ok(sysCache);
}
+ /**
+ * 娓呯悊缂撳瓨鐩戞帶缂撳瓨鍚�
+ *
+ * @param cacheName 缂撳瓨鍚�
+ */
@SaCheckPermission("monitor:cache:list")
@DeleteMapping("/clearCacheName/{cacheName}")
public R<Void> clearCacheName(@PathVariable String cacheName) {
@@ -94,6 +116,11 @@
return R.ok();
}
+ /**
+ * 娓呯悊缂撳瓨鐩戞帶Key
+ *
+ * @param cacheKey key鍚�
+ */
@SaCheckPermission("monitor:cache:list")
@DeleteMapping("/clearCacheKey/{cacheKey}")
public R<Void> clearCacheKey(@PathVariable String cacheKey) {
@@ -101,6 +128,9 @@
return R.ok();
}
+ /**
+ * 娓呯悊鍏ㄩ儴缂撳瓨鐩戞帶
+ */
@SaCheckPermission("monitor:cache:list")
@DeleteMapping("/clearCacheAll")
public R<Void> clearCacheAll() {
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysLogininforController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysLogininforController.java
index 4b82b4a..a58c54e 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysLogininforController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysLogininforController.java
@@ -24,7 +24,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="绯荤粺璁块棶璁板綍", description = "绯荤粺璁块棶璁板綍绠＄悊")
+@Tag(name = "绯荤粺璁块棶璁板綍", description = "绯荤粺璁块棶璁板綍绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/monitor/logininfor")
@@ -32,12 +32,18 @@
private final ISysLogininforService logininforService;
+ /**
+ * 鑾峰彇绯荤粺璁块棶璁板綍鍒楄〃
+ */
@SaCheckPermission("monitor:logininfor:list")
@GetMapping("/list")
public TableDataInfo<SysLogininfor> list(SysLogininfor logininfor, PageQuery pageQuery) {
return logininforService.selectPageLogininforList(logininfor, pageQuery);
}
+ /**
+ * 瀵煎嚭绯荤粺璁块棶璁板綍鍒楄〃
+ */
@Log(title = "鐧诲綍鏃ュ織", businessType = BusinessType.EXPORT)
@SaCheckPermission("monitor:logininfor:export")
@PostMapping("/export")
@@ -46,6 +52,9 @@
ExcelUtil.exportExcel(list, "鐧诲綍鏃ュ織", SysLogininfor.class, response);
}
+ /**
+ * 鑾峰彇绯荤粺璁块棶璁板綍璇︽儏
+ */
@SaCheckPermission("monitor:logininfor:remove")
@Log(title = "鐧诲綍鏃ュ織", businessType = BusinessType.DELETE)
@DeleteMapping("/{infoIds}")
@@ -53,6 +62,9 @@
return toAjax(logininforService.deleteLogininforByIds(infoIds));
}
+ /**
+ * 娓呯悊绯荤粺璁块棶璁板綍
+ */
@SaCheckPermission("monitor:logininfor:remove")
@Log(title = "鐧诲綍鏃ュ織", businessType = BusinessType.CLEAN)
@DeleteMapping("/clean")
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysOperlogController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysOperlogController.java
index d7dcff4..7176962 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysOperlogController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysOperlogController.java
@@ -24,7 +24,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鎿嶄綔鏃ュ織璁板綍", description = "鎿嶄綔鏃ュ織璁板綍绠＄悊")
+@Tag(name = "鎿嶄綔鏃ュ織璁板綍", description = "鎿嶄綔鏃ュ織璁板綍绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/monitor/operlog")
@@ -32,12 +32,18 @@
private final ISysOperLogService operLogService;
+ /**
+ * 鑾峰彇鎿嶄綔鏃ュ織璁板綍鍒楄〃
+ */
@SaCheckPermission("monitor:operlog:list")
@GetMapping("/list")
public TableDataInfo<SysOperLog> list(SysOperLog operLog, PageQuery pageQuery) {
return operLogService.selectPageOperLogList(operLog, pageQuery);
}
+ /**
+ * 瀵煎嚭鎿嶄綔鏃ュ織璁板綍鍒楄〃
+ */
@Log(title = "鎿嶄綔鏃ュ織", businessType = BusinessType.EXPORT)
@SaCheckPermission("monitor:operlog:export")
@PostMapping("/export")
@@ -46,6 +52,9 @@
ExcelUtil.exportExcel(list, "鎿嶄綔鏃ュ織", SysOperLog.class, response);
}
+ /**
+ * 鑾峰彇鎿嶄綔鏃ュ織璁板綍璇︽儏
+ */
@Log(title = "鎿嶄綔鏃ュ織", businessType = BusinessType.DELETE)
@SaCheckPermission("monitor:operlog:remove")
@DeleteMapping("/{operIds}")
@@ -53,6 +62,9 @@
return toAjax(operLogService.deleteOperLogByIds(operIds));
}
+ /**
+ * 娓呯悊鎿嶄綔鏃ュ織璁板綍
+ */
@Log(title = "鎿嶄綔鏃ュ織", businessType = BusinessType.CLEAN)
@SaCheckPermission("monitor:operlog:remove")
@DeleteMapping("/clean")
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysUserOnlineController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysUserOnlineController.java
index f35549c..ec611ca 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysUserOnlineController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysUserOnlineController.java
@@ -28,12 +28,18 @@
*
* @author Lion Li
*/
-@Tag(name ="鍦ㄧ嚎鐢ㄦ埛鐩戞帶", description = "鍦ㄧ嚎鐢ㄦ埛鐩戞帶绠＄悊")
+@Tag(name = "鍦ㄧ嚎鐢ㄦ埛鐩戞帶", description = "鍦ㄧ嚎鐢ㄦ埛鐩戞帶绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/monitor/online")
public class SysUserOnlineController extends BaseController {
+ /**
+ * 鑾峰彇鍦ㄧ嚎鐢ㄦ埛鐩戞帶鍒楄〃
+ *
+ * @param ipaddr IP鍦板潃
+ * @param userName 鐢ㄦ埛鍚�
+ */
@SaCheckPermission("monitor:online:list")
@GetMapping("/list")
public TableDataInfo<SysUserOnline> list(String ipaddr, String userName) {
@@ -55,7 +61,7 @@
);
} else if (StringUtils.isNotEmpty(ipaddr)) {
userOnlineDTOList = StreamUtils.filter(userOnlineDTOList, userOnline ->
- StringUtils.equals(ipaddr, userOnline.getIpaddr())
+ StringUtils.equals(ipaddr, userOnline.getIpaddr())
);
} else if (StringUtils.isNotEmpty(userName)) {
userOnlineDTOList = StreamUtils.filter(userOnlineDTOList, userOnline ->
@@ -70,6 +76,8 @@
/**
* 寮洪��鐢ㄦ埛
+ *
+ * @param tokenId token鍊�
*/
@SaCheckPermission("monitor:online:forceLogout")
@Log(title = "鍦ㄧ嚎鐢ㄦ埛", businessType = BusinessType.FORCE)
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java
index 3e26979..d2cdcb7 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java
@@ -11,7 +11,6 @@
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysConfig;
import com.ruoyi.system.service.ISysConfigService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -26,7 +25,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鍙傛暟閰嶇疆鎺у埗鍣�", description = "鍙傛暟閰嶇疆绠＄悊")
+@Tag(name = "鍙傛暟閰嶇疆鎺у埗鍣�", description = "鍙傛暟閰嶇疆绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/config")
@@ -43,6 +42,9 @@
return configService.selectPageConfigList(config, pageQuery);
}
+ /**
+ * 瀵煎嚭鍙傛暟閰嶇疆鍒楄〃
+ */
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:config:export")
@PostMapping("/export")
@@ -53,18 +55,22 @@
/**
* 鏍规嵁鍙傛暟缂栧彿鑾峰彇璇︾粏淇℃伅
+ *
+ * @param configId 鍙傛暟ID
*/
@SaCheckPermission("system:config:query")
@GetMapping(value = "/{configId}")
- public R<SysConfig> getInfo(@Parameter(name = "鍙傛暟ID") @PathVariable Long configId) {
+ public R<SysConfig> getInfo(@PathVariable Long configId) {
return R.ok(configService.selectConfigById(configId));
}
/**
* 鏍规嵁鍙傛暟閿悕鏌ヨ鍙傛暟鍊�
+ *
+ * @param configKey 鍙傛暟Key
*/
@GetMapping(value = "/configKey/{configKey}")
- public R<Void> getConfigKey(@Parameter(name = "鍙傛暟Key") @PathVariable String configKey) {
+ public R<Void> getConfigKey(@PathVariable String configKey) {
return R.ok(configService.selectConfigByKey(configKey));
}
@@ -106,11 +112,13 @@
/**
* 鍒犻櫎鍙傛暟閰嶇疆
+ *
+ * @param configIds 鍙傛暟ID涓�
*/
@SaCheckPermission("system:config:remove")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{configIds}")
- public R<Void> remove(@Parameter(name = "鍙傛暟ID涓�") @PathVariable Long[] configIds) {
+ public R<Void> remove(@PathVariable Long[] configIds) {
configService.deleteConfigByIds(configIds);
return R.ok();
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDeptController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDeptController.java
index 3dedb11..b17cf51 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDeptController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDeptController.java
@@ -11,7 +11,6 @@
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.system.service.ISysDeptService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -27,7 +26,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="閮ㄩ棬鎺у埗鍣�", description = "閮ㄩ棬绠＄悊")
+@Tag(name = "閮ㄩ棬鎺у埗鍣�", description = "閮ㄩ棬绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/dept")
@@ -47,10 +46,12 @@
/**
* 鏌ヨ閮ㄩ棬鍒楄〃锛堟帓闄よ妭鐐癸級
+ *
+ * @param deptId 閮ㄩ棬ID
*/
@SaCheckPermission("system:dept:list")
@GetMapping("/list/exclude/{deptId}")
- public R<List<SysDept>> excludeChild(@Parameter(name = "閮ㄩ棬ID") @PathVariable(value = "deptId", required = false) Long deptId) {
+ public R<List<SysDept>> excludeChild(@PathVariable(value = "deptId", required = false) Long deptId) {
List<SysDept> depts = deptService.selectDeptList(new SysDept());
depts.removeIf(d -> d.getDeptId().equals(deptId)
|| ArrayUtil.contains(StringUtils.split(d.getAncestors(), ","), deptId + ""));
@@ -59,10 +60,12 @@
/**
* 鏍规嵁閮ㄩ棬缂栧彿鑾峰彇璇︾粏淇℃伅
+ *
+ * @param deptId 閮ㄩ棬ID
*/
@SaCheckPermission("system:dept:query")
@GetMapping(value = "/{deptId}")
- public R<SysDept> getInfo(@Parameter(name = "閮ㄩ棬ID") @PathVariable Long deptId) {
+ public R<SysDept> getInfo(@PathVariable Long deptId) {
deptService.checkDeptDataScope(deptId);
return R.ok(deptService.selectDeptById(deptId));
}
@@ -78,9 +81,11 @@
/**
* 鍔犺浇瀵瑰簲瑙掕壊閮ㄩ棬鍒楄〃鏍�
+ *
+ * @param roleId 瑙掕壊ID
*/
@GetMapping(value = "/roleDeptTreeselect/{roleId}")
- public R<Map<String, Object>> roleDeptTreeselect(@Parameter(name = "瑙掕壊ID") @PathVariable("roleId") Long roleId) {
+ public R<Map<String, Object>> roleDeptTreeselect(@PathVariable("roleId") Long roleId) {
List<SysDept> depts = deptService.selectDeptList(new SysDept());
Map<String, Object> ajax = new HashMap<>();
ajax.put("checkedKeys", deptService.selectDeptListByRoleId(roleId));
@@ -123,11 +128,13 @@
/**
* 鍒犻櫎閮ㄩ棬
+ *
+ * @param deptId 閮ㄩ棬ID
*/
@SaCheckPermission("system:dept:remove")
@Log(title = "閮ㄩ棬绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{deptId}")
- public R<Void> remove(@Parameter(name = "閮ㄩ棬ID涓�") @PathVariable Long deptId) {
+ public R<Void> remove(@PathVariable Long deptId) {
if (deptService.hasChildByDeptId(deptId)) {
return R.fail("瀛樺湪涓嬬骇閮ㄩ棬,涓嶅厑璁稿垹闄�");
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java
index a659f6d..6dfa05f 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java
@@ -12,7 +12,6 @@
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.service.ISysDictDataService;
import com.ruoyi.system.service.ISysDictTypeService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -28,7 +27,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鏁版嵁瀛楀吀淇℃伅鎺у埗鍣�", description = "鏁版嵁瀛楀吀淇℃伅绠＄悊")
+@Tag(name = "鏁版嵁瀛楀吀淇℃伅鎺у埗鍣�", description = "鏁版嵁瀛楀吀淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/dict/data")
@@ -37,12 +36,18 @@
private final ISysDictDataService dictDataService;
private final ISysDictTypeService dictTypeService;
+ /**
+ * 鏌ヨ瀛楀吀鏁版嵁鍒楄〃
+ */
@SaCheckPermission("system:dict:list")
@GetMapping("/list")
public TableDataInfo<SysDictData> list(SysDictData dictData, PageQuery pageQuery) {
return dictDataService.selectPageDictDataList(dictData, pageQuery);
}
+ /**
+ * 瀵煎嚭瀛楀吀鏁版嵁鍒楄〃
+ */
@Log(title = "瀛楀吀鏁版嵁", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:dict:export")
@PostMapping("/export")
@@ -53,18 +58,22 @@
/**
* 鏌ヨ瀛楀吀鏁版嵁璇︾粏
+ *
+ * @param dictCode 瀛楀吀code
*/
@SaCheckPermission("system:dict:query")
@GetMapping(value = "/{dictCode}")
- public R<SysDictData> getInfo(@Parameter(name = "瀛楀吀code") @PathVariable Long dictCode) {
+ public R<SysDictData> getInfo(@PathVariable Long dictCode) {
return R.ok(dictDataService.selectDictDataById(dictCode));
}
/**
* 鏍规嵁瀛楀吀绫诲瀷鏌ヨ瀛楀吀鏁版嵁淇℃伅
+ *
+ * @param dictType 瀛楀吀绫诲瀷
*/
@GetMapping(value = "/type/{dictType}")
- public R<List<SysDictData>> dictType(@Parameter(name = "瀛楀吀绫诲瀷") @PathVariable String dictType) {
+ public R<List<SysDictData>> dictType(@PathVariable String dictType) {
List<SysDictData> data = dictTypeService.selectDictDataByType(dictType);
if (ObjectUtil.isNull(data)) {
data = new ArrayList<>();
@@ -94,11 +103,13 @@
/**
* 鍒犻櫎瀛楀吀绫诲瀷
+ *
+ * @param dictCodes 瀛楀吀code涓�
*/
@SaCheckPermission("system:dict:remove")
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.DELETE)
@DeleteMapping("/{dictCodes}")
- public R<Void> remove(@Parameter(name = "瀛楀吀code涓�") @PathVariable Long[] dictCodes) {
+ public R<Void> remove(@PathVariable Long[] dictCodes) {
dictDataService.deleteDictDataByIds(dictCodes);
return R.ok();
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java
index 5cabe85..3eb3480 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java
@@ -11,7 +11,6 @@
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.service.ISysDictTypeService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -26,7 +25,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鏁版嵁瀛楀吀淇℃伅鎺у埗鍣�", description = "鏁版嵁瀛楀吀淇℃伅绠＄悊")
+@Tag(name = "鏁版嵁瀛楀吀淇℃伅鎺у埗鍣�", description = "鏁版嵁瀛楀吀淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/dict/type")
@@ -34,12 +33,18 @@
private final ISysDictTypeService dictTypeService;
+ /**
+ * 鏌ヨ瀛楀吀绫诲瀷鍒楄〃
+ */
@SaCheckPermission("system:dict:list")
@GetMapping("/list")
public TableDataInfo<SysDictType> list(SysDictType dictType, PageQuery pageQuery) {
return dictTypeService.selectPageDictTypeList(dictType, pageQuery);
}
+ /**
+ * 瀵煎嚭瀛楀吀绫诲瀷鍒楄〃
+ */
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:dict:export")
@PostMapping("/export")
@@ -50,10 +55,12 @@
/**
* 鏌ヨ瀛楀吀绫诲瀷璇︾粏
+ *
+ * @param dictId 瀛楀吀ID
*/
@SaCheckPermission("system:dict:query")
@GetMapping(value = "/{dictId}")
- public R<SysDictType> getInfo(@Parameter(name = "瀛楀吀ID") @PathVariable Long dictId) {
+ public R<SysDictType> getInfo(@PathVariable Long dictId) {
return R.ok(dictTypeService.selectDictTypeById(dictId));
}
@@ -85,11 +92,13 @@
/**
* 鍒犻櫎瀛楀吀绫诲瀷
+ *
+ * @param dictIds 瀛楀吀ID涓�
*/
@SaCheckPermission("system:dict:remove")
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.DELETE)
@DeleteMapping("/{dictIds}")
- public R<Void> remove(@Parameter(name = "瀛楀吀ID涓�") @PathVariable Long[] dictIds) {
+ public R<Void> remove(@PathVariable Long[] dictIds) {
dictTypeService.deleteDictTypeByIds(dictIds);
return R.ok();
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysLoginController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysLoginController.java
index 4cd9053..10b9dce 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysLoginController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysLoginController.java
@@ -33,7 +33,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鐧诲綍楠岃瘉鎺у埗鍣�", description = "鐧诲綍楠岃瘉绠＄悊")
+@Tag(name = "鐧诲綍楠岃瘉鎺у埗鍣�", description = "鐧诲綍楠岃瘉绠＄悊")
@RequiredArgsConstructor
@RestController
public class SysLoginController {
@@ -92,6 +92,9 @@
return R.ok(ajax);
}
+ /**
+ * 閫�鍑虹櫥褰�
+ */
@Anonymous
@PostMapping("/logout")
public R<Void> logout() {
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysMenuController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysMenuController.java
index 1e87e67..713dfbe 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysMenuController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysMenuController.java
@@ -10,7 +10,6 @@
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.system.service.ISysMenuService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -26,7 +25,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鑿滃崟淇℃伅鎺у埗鍣�", description = "鑿滃崟淇℃伅绠＄悊")
+@Tag(name = "鑿滃崟淇℃伅鎺у埗鍣�", description = "鑿滃崟淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/menu")
@@ -46,10 +45,12 @@
/**
* 鏍规嵁鑿滃崟缂栧彿鑾峰彇璇︾粏淇℃伅
+ *
+ * @param menuId 鑿滃崟ID
*/
@SaCheckPermission("system:menu:query")
@GetMapping(value = "/{menuId}")
- public R<SysMenu> getInfo(@Parameter(name = "鑿滃崟ID") @PathVariable Long menuId) {
+ public R<SysMenu> getInfo(@PathVariable Long menuId) {
return R.ok(menuService.selectMenuById(menuId));
}
@@ -64,9 +65,11 @@
/**
* 鍔犺浇瀵瑰簲瑙掕壊鑿滃崟鍒楄〃鏍�
+ *
+ * @param roleId 瑙掕壊ID
*/
@GetMapping(value = "/roleMenuTreeselect/{roleId}")
- public R<Map<String, Object>> roleMenuTreeselect(@Parameter(name = "瑙掕壊ID") @PathVariable("roleId") Long roleId) {
+ public R<Map<String, Object>> roleMenuTreeselect(@PathVariable("roleId") Long roleId) {
List<SysMenu> menus = menuService.selectMenuList(getUserId());
Map<String, Object> ajax = new HashMap<>();
ajax.put("checkedKeys", menuService.selectMenuListByRoleId(roleId));
@@ -108,11 +111,13 @@
/**
* 鍒犻櫎鑿滃崟
+ *
+ * @param menuId 鑿滃崟ID
*/
@SaCheckPermission("system:menu:remove")
@Log(title = "鑿滃崟绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{menuId}")
- public R<Void> remove(@Parameter(name = "鑿滃崟ID") @PathVariable("menuId") Long menuId) {
+ public R<Void> remove(@PathVariable("menuId") Long menuId) {
if (menuService.hasChildByMenuId(menuId)) {
return R.fail("瀛樺湪瀛愯彍鍗�,涓嶅厑璁稿垹闄�");
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java
index 10a8371..0e2eb58 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java
@@ -9,7 +9,6 @@
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.system.domain.SysNotice;
import com.ruoyi.system.service.ISysNoticeService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -21,7 +20,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鍏憡淇℃伅鎺у埗鍣�", description = "鍏憡淇℃伅绠＄悊")
+@Tag(name = "鍏憡淇℃伅鎺у埗鍣�", description = "鍏憡淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/notice")
@@ -40,10 +39,12 @@
/**
* 鏍规嵁閫氱煡鍏憡缂栧彿鑾峰彇璇︾粏淇℃伅
+ *
+ * @param noticeId 鍏憡ID
*/
@SaCheckPermission("system:notice:query")
@GetMapping(value = "/{noticeId}")
- public R<SysNotice> getInfo(@Parameter(name = "鍏憡ID") @PathVariable Long noticeId) {
+ public R<SysNotice> getInfo(@PathVariable Long noticeId) {
return R.ok(noticeService.selectNoticeById(noticeId));
}
@@ -69,11 +70,13 @@
/**
* 鍒犻櫎閫氱煡鍏憡
+ *
+ * @param noticeIds 鍏憡ID涓�
*/
@SaCheckPermission("system:notice:remove")
@Log(title = "閫氱煡鍏憡", businessType = BusinessType.DELETE)
@DeleteMapping("/{noticeIds}")
- public R<Void> remove(@Parameter(name = "鍏憡ID涓�") @PathVariable Long[] noticeIds) {
+ public R<Void> remove(@PathVariable Long[] noticeIds) {
return toAjax(noticeService.deleteNoticeByIds(noticeIds));
}
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java
index 023f349..c9afca0 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java
@@ -14,7 +14,6 @@
import com.ruoyi.system.domain.bo.SysOssConfigBo;
import com.ruoyi.system.domain.vo.SysOssConfigVo;
import com.ruoyi.system.service.ISysOssConfigService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -25,14 +24,14 @@
import java.util.Arrays;
/**
- * 瀵硅薄瀛樺偍閰嶇疆Controller
+ * 瀵硅薄瀛樺偍閰嶇疆
*
* @author Lion Li
* @author 瀛よ垷鐑熼洦
* @date 2021-08-13
*/
@Validated
-@Tag(name ="瀵硅薄瀛樺偍閰嶇疆鎺у埗鍣�", description = "瀵硅薄瀛樺偍閰嶇疆绠＄悊")
+@Tag(name = "瀵硅薄瀛樺偍閰嶇疆鎺у埗鍣�", description = "瀵硅薄瀛樺偍閰嶇疆绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/oss/config")
@@ -51,12 +50,13 @@
/**
* 鑾峰彇瀵硅薄瀛樺偍閰嶇疆璇︾粏淇℃伅
+ *
+ * @param ossConfigId OSS閰嶇疆ID
*/
@SaCheckPermission("system:oss:query")
@GetMapping("/{ossConfigId}")
- public R<SysOssConfigVo> getInfo(@Parameter(name = "OSS閰嶇疆ID")
- @NotNull(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable("ossConfigId") Long ossConfigId) {
+ public R<SysOssConfigVo> getInfo(@NotNull(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable Long ossConfigId) {
return R.ok(iSysOssConfigService.queryById(ossConfigId));
}
@@ -84,13 +84,14 @@
/**
* 鍒犻櫎瀵硅薄瀛樺偍閰嶇疆
+ *
+ * @param ossConfigIds OSS閰嶇疆ID涓�
*/
@SaCheckPermission("system:oss:remove")
@Log(title = "瀵硅薄瀛樺偍閰嶇疆", businessType = BusinessType.DELETE)
@DeleteMapping("/{ossConfigIds}")
- public R<Void> remove(@Parameter(name = "OSS閰嶇疆ID涓�")
- @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable Long[] ossConfigIds) {
+ public R<Void> remove(@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable Long[] ossConfigIds) {
return toAjax(iSysOssConfigService.deleteWithValidByIds(Arrays.asList(ossConfigIds), true) ? 1 : 0);
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java
index e40c2f5..85faa16 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java
@@ -19,9 +19,6 @@
import com.ruoyi.system.domain.bo.SysOssBo;
import com.ruoyi.system.domain.vo.SysOssVo;
import com.ruoyi.system.service.ISysOssService;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.Parameters;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.http.MediaType;
@@ -43,7 +40,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="瀵硅薄瀛樺偍鎺у埗鍣�", description = "瀵硅薄瀛樺偍绠＄悊")
+@Tag(name = "瀵硅薄瀛樺偍鎺у埗鍣�", description = "瀵硅薄瀛樺偍绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/oss")
@@ -62,25 +59,25 @@
/**
* 鏌ヨOSS瀵硅薄鍩轰簬id涓�
+ *
+ * @param ossIds OSS瀵硅薄ID涓�
*/
@SaCheckPermission("system:oss:list")
@GetMapping("/listByIds/{ossIds}")
- public R<List<SysOssVo>> listByIds(@Parameter(name = "OSS瀵硅薄ID涓�")
- @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable Long[] ossIds) {
+ public R<List<SysOssVo>> listByIds(@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable Long[] ossIds) {
List<SysOssVo> list = iSysOssService.listByIds(Arrays.asList(ossIds));
return R.ok(list);
}
/**
* 涓婁紶OSS瀵硅薄瀛樺偍
+ *
+ * @param file 鏂囦欢
*/
- @Parameters({
- @Parameter(name = "file", description = "鏂囦欢", in = ParameterIn.QUERY, required = true)
- })
@SaCheckPermission("system:oss:upload")
@Log(title = "OSS瀵硅薄瀛樺偍", businessType = BusinessType.INSERT)
- @PostMapping("/upload")
+ @PostMapping(value = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public R<Map<String, String>> upload(@RequestPart("file") MultipartFile file) {
if (ObjectUtil.isNull(file)) {
throw new ServiceException("涓婁紶鏂囦欢涓嶈兘涓虹┖");
@@ -93,9 +90,14 @@
return R.ok(map);
}
+ /**
+ * 涓嬭浇OSS瀵硅薄
+ *
+ * @param ossId OSS瀵硅薄ID
+ */
@SaCheckPermission("system:oss:download")
@GetMapping("/download/{ossId}")
- public void download(@Parameter(name = "OSS瀵硅薄ID") @PathVariable Long ossId, HttpServletResponse response) throws IOException {
+ public void download(@PathVariable Long ossId, HttpServletResponse response) throws IOException {
SysOss sysOss = iSysOssService.getById(ossId);
if (ObjectUtil.isNull(sysOss)) {
throw new ServiceException("鏂囦欢鏁版嵁涓嶅瓨鍦�!");
@@ -118,13 +120,14 @@
/**
* 鍒犻櫎OSS瀵硅薄瀛樺偍
+ *
+ * @param ossIds OSS瀵硅薄ID涓�
*/
@SaCheckPermission("system:oss:remove")
@Log(title = "OSS瀵硅薄瀛樺偍", businessType = BusinessType.DELETE)
@DeleteMapping("/{ossIds}")
- public R<Void> remove(@Parameter(name = "OSS瀵硅薄ID涓�")
- @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable Long[] ossIds) {
+ public R<Void> remove(@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable Long[] ossIds) {
return toAjax(iSysOssService.deleteWithValidByIds(Arrays.asList(ossIds), true) ? 1 : 0);
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java
index a78ac4b..5feaa6c 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java
@@ -11,7 +11,6 @@
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysPost;
import com.ruoyi.system.service.ISysPostService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -43,6 +42,9 @@
return postService.selectPagePostList(post, pageQuery);
}
+ /**
+ * 瀵煎嚭宀椾綅鍒楄〃
+ */
@Log(title = "宀椾綅绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:post:export")
@PostMapping("/export")
@@ -53,10 +55,12 @@
/**
* 鏍规嵁宀椾綅缂栧彿鑾峰彇璇︾粏淇℃伅
+ *
+ * @param postId 宀椾綅ID
*/
@SaCheckPermission("system:post:query")
@GetMapping(value = "/{postId}")
- public R<SysPost> getInfo(@Parameter(name = "宀椾綅ID") @PathVariable Long postId) {
+ public R<SysPost> getInfo(@PathVariable Long postId) {
return R.ok(postService.selectPostById(postId));
}
@@ -92,11 +96,13 @@
/**
* 鍒犻櫎宀椾綅
+ *
+ * @param postIds 宀椾綅ID涓�
*/
@SaCheckPermission("system:post:remove")
@Log(title = "宀椾綅绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{postIds}")
- public R<Void> remove(@Parameter(name = "宀椾綅ID涓�") @PathVariable Long[] postIds) {
+ public R<Void> remove(@PathVariable Long[] postIds) {
return toAjax(postService.deletePostByIds(postIds));
}
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysProfileController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysProfileController.java
index bb63b07..ee45ac2 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysProfileController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysProfileController.java
@@ -14,11 +14,9 @@
import com.ruoyi.system.domain.SysOss;
import com.ruoyi.system.service.ISysOssService;
import com.ruoyi.system.service.ISysUserService;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.Parameters;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
@@ -33,7 +31,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="涓汉淇℃伅鎺у埗鍣�", description = "涓汉淇℃伅绠＄悊")
+@Tag(name = "涓汉淇℃伅鎺у埗鍣�", description = "涓汉淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/user/profile")
@@ -80,11 +78,10 @@
/**
* 閲嶇疆瀵嗙爜
+ *
+ * @param newPassword 鏃у瘑鐮�
+ * @param oldPassword 鏂板瘑鐮�
*/
- @Parameters({
- @Parameter(name = "oldPassword", description = "鏃у瘑鐮�", in = ParameterIn.QUERY),
- @Parameter(name = "newPassword", description = "鏂板瘑鐮�", in = ParameterIn.QUERY)
- })
@Log(title = "涓汉淇℃伅", businessType = BusinessType.UPDATE)
@PutMapping("/updatePwd")
public R<Void> updatePwd(String oldPassword, String newPassword) {
@@ -106,20 +103,19 @@
/**
* 澶村儚涓婁紶
+ *
+ * @param avatarfile 鐢ㄦ埛澶村儚
*/
- @Parameters({
- @Parameter(name = "avatarfile", description = "鐢ㄦ埛澶村儚", in = ParameterIn.QUERY, required = true)
- })
@Log(title = "鐢ㄦ埛澶村儚", businessType = BusinessType.UPDATE)
- @PostMapping("/avatar")
- public R<Map<String, Object>> avatar(@RequestPart("avatarfile") MultipartFile file) {
+ @PostMapping(value = "/avatar", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+ public R<Map<String, Object>> avatar(@RequestPart("avatarfile") MultipartFile avatarfile) {
Map<String, Object> ajax = new HashMap<>();
- if (!file.isEmpty()) {
- String extension = FileUtil.extName(file.getOriginalFilename());
+ if (!avatarfile.isEmpty()) {
+ String extension = FileUtil.extName(avatarfile.getOriginalFilename());
if (!StringUtils.equalsAnyIgnoreCase(extension, MimeTypeUtils.IMAGE_EXTENSION)) {
return R.fail("鏂囦欢鏍煎紡涓嶆纭紝璇蜂笂浼�" + Arrays.toString(MimeTypeUtils.IMAGE_EXTENSION) + "鏍煎紡");
}
- SysOss oss = iSysOssService.upload(file);
+ SysOss oss = iSysOssService.upload(avatarfile);
String avatar = oss.getUrl();
if (userService.updateUserAvatar(getUsername(), avatar)) {
ajax.put("imgUrl", avatar);
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRegisterController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRegisterController.java
index cc05960..79b5d86 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRegisterController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRegisterController.java
@@ -19,7 +19,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="娉ㄥ唽楠岃瘉鎺у埗鍣�", description = "娉ㄥ唽楠岃瘉绠＄悊")
+@Tag(name = "娉ㄥ唽楠岃瘉鎺у埗鍣�", description = "娉ㄥ唽楠岃瘉绠＄悊")
@RequiredArgsConstructor
@RestController
public class SysRegisterController extends BaseController {
@@ -27,6 +27,9 @@
private final SysRegisterService registerService;
private final ISysConfigService configService;
+ /**
+ * 鐢ㄦ埛娉ㄥ唽
+ */
@Anonymous
@PostMapping("/register")
public R<Void> register(@Validated @RequestBody RegisterBody user) {
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java
index fc0e5a7..31694b0 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java
@@ -18,9 +18,6 @@
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
import com.ruoyi.system.service.SysPermissionService;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.Parameters;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -35,7 +32,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="瑙掕壊淇℃伅鎺у埗鍣�", description = "瑙掕壊淇℃伅绠＄悊")
+@Tag(name = "瑙掕壊淇℃伅鎺у埗鍣�", description = "瑙掕壊淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/role")
@@ -45,12 +42,18 @@
private final ISysUserService userService;
private final SysPermissionService permissionService;
+ /**
+ * 鑾峰彇瑙掕壊淇℃伅鍒楄〃
+ */
@SaCheckPermission("system:role:list")
@GetMapping("/list")
public TableDataInfo<SysRole> list(SysRole role, PageQuery pageQuery) {
return roleService.selectPageRoleList(role, pageQuery);
}
+ /**
+ * 瀵煎嚭瑙掕壊淇℃伅鍒楄〃
+ */
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:role:export")
@PostMapping("/export")
@@ -61,10 +64,12 @@
/**
* 鏍规嵁瑙掕壊缂栧彿鑾峰彇璇︾粏淇℃伅
+ *
+ * @param roleId 瑙掕壊ID
*/
@SaCheckPermission("system:role:query")
@GetMapping(value = "/{roleId}")
- public R<SysRole> getInfo(@Parameter(name = "瑙掕壊ID") @PathVariable Long roleId) {
+ public R<SysRole> getInfo(@PathVariable Long roleId) {
roleService.checkRoleDataScope(roleId);
return R.ok(roleService.selectRoleById(roleId));
}
@@ -139,11 +144,13 @@
/**
* 鍒犻櫎瑙掕壊
+ *
+ * @param roleIds 瑙掕壊ID涓�
*/
@SaCheckPermission("system:role:remove")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{roleIds}")
- public R<Void> remove(@Parameter(name = "瑙掕壊ID涓�") @PathVariable Long[] roleIds) {
+ public R<Void> remove(@PathVariable Long[] roleIds) {
return toAjax(roleService.deleteRoleByIds(roleIds));
}
@@ -186,11 +193,10 @@
/**
* 鎵归噺鍙栨秷鎺堟潈鐢ㄦ埛
+ *
+ * @param roleId 瑙掕壊ID
+ * @param userIds 鐢ㄦ埛ID涓�
*/
- @Parameters({
- @Parameter(name = "roleId", description = "瑙掕壊ID", in = ParameterIn.QUERY),
- @Parameter(name = "userIds", description = "鐢ㄦ埛ID涓�", in = ParameterIn.QUERY)
- })
@SaCheckPermission("system:role:edit")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.GRANT)
@PutMapping("/authUser/cancelAll")
@@ -200,11 +206,10 @@
/**
* 鎵归噺閫夋嫨鐢ㄦ埛鎺堟潈
+ *
+ * @param roleId 瑙掕壊ID
+ * @param userIds 鐢ㄦ埛ID涓�
*/
- @Parameters({
- @Parameter(name = "roleId", description = "瑙掕壊ID", in = ParameterIn.QUERY),
- @Parameter(name = "userIds", description = "鐢ㄦ埛ID涓�", in = ParameterIn.QUERY)
- })
@SaCheckPermission("system:role:edit")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.GRANT)
@PutMapping("/authUser/selectAll")
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysUserController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysUserController.java
index cb564b6..c32af70 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysUserController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysUserController.java
@@ -26,11 +26,9 @@
import com.ruoyi.system.service.ISysPostService;
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.Parameters;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
@@ -47,7 +45,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="鐢ㄦ埛淇℃伅鎺у埗鍣�", description = "鐢ㄦ埛淇℃伅绠＄悊")
+@Tag(name = "鐢ㄦ埛淇℃伅鎺у埗鍣�", description = "鐢ㄦ埛淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/user")
@@ -66,6 +64,9 @@
return userService.selectPageUserList(user, pageQuery);
}
+ /**
+ * 瀵煎嚭鐢ㄦ埛鍒楄〃
+ */
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:user:export")
@PostMapping("/export")
@@ -83,17 +84,23 @@
ExcelUtil.exportExcel(listVo, "鐢ㄦ埛鏁版嵁", SysUserExportVo.class, response);
}
- @Parameters({
- @Parameter(name = "file", description = "瀵煎叆鏂囦欢", required = true),
- })
+ /**
+ * 瀵煎叆鏁版嵁
+ *
+ * @param file 瀵煎叆鏂囦欢
+ * @param updateSupport 鏄惁鏇存柊宸插瓨鍦ㄦ暟鎹�
+ */
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.IMPORT)
@SaCheckPermission("system:user:import")
- @PostMapping("/importData")
+ @PostMapping(value = "/importData", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public R<Void> importData(@RequestPart("file") MultipartFile file, boolean updateSupport) throws Exception {
ExcelResult<SysUserImportVo> result = ExcelUtil.importExcel(file.getInputStream(), SysUserImportVo.class, new SysUserImportListener(updateSupport));
return R.ok(result.getAnalysis());
}
+ /**
+ * 鑾峰彇瀵煎叆妯℃澘
+ */
@PostMapping("/importTemplate")
public void importTemplate(HttpServletResponse response) {
ExcelUtil.exportExcel(new ArrayList<>(), "鐢ㄦ埛鏁版嵁", SysUserImportVo.class, response);
@@ -101,10 +108,12 @@
/**
* 鏍规嵁鐢ㄦ埛缂栧彿鑾峰彇璇︾粏淇℃伅
+ *
+ * @param userId 鐢ㄦ埛ID
*/
@SaCheckPermission("system:user:query")
@GetMapping(value = {"/", "/{userId}"})
- public R<Map<String, Object>> getInfo(@Parameter(name = "鐢ㄦ埛ID") @PathVariable(value = "userId", required = false) Long userId) {
+ public R<Map<String, Object>> getInfo(@PathVariable(value = "userId", required = false) Long userId) {
userService.checkUserDataScope(userId);
Map<String, Object> ajax = new HashMap<>();
List<SysRole> roles = roleService.selectRoleAll();
@@ -160,11 +169,13 @@
/**
* 鍒犻櫎鐢ㄦ埛
+ *
+ * @param userIds 瑙掕壊ID涓�
*/
@SaCheckPermission("system:user:remove")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{userIds}")
- public R<Void> remove(@Parameter(name = "瑙掕壊ID涓�") @PathVariable Long[] userIds) {
+ public R<Void> remove(@PathVariable Long[] userIds) {
if (ArrayUtil.contains(userIds, getUserId())) {
return R.fail("褰撳墠鐢ㄦ埛涓嶈兘鍒犻櫎");
}
@@ -198,10 +209,12 @@
/**
* 鏍规嵁鐢ㄦ埛缂栧彿鑾峰彇鎺堟潈瑙掕壊
+ *
+ * @param userId 鐢ㄦ埛ID
*/
@SaCheckPermission("system:user:query")
@GetMapping("/authRole/{userId}")
- public R<Map<String, Object>> authRole(@Parameter(name = "鐢ㄦ埛ID") @PathVariable("userId") Long userId) {
+ public R<Map<String, Object>> authRole(@PathVariable Long userId) {
SysUser user = userService.selectUserById(userId);
List<SysRole> roles = roleService.selectRolesByUserId(userId);
Map<String, Object> ajax = new HashMap<>();
@@ -212,11 +225,10 @@
/**
* 鐢ㄦ埛鎺堟潈瑙掕壊
+ *
+ * @param userId 鐢ㄦ埛Id
+ * @param roleIds 瑙掕壊ID涓�
*/
- @Parameters({
- @Parameter(name = "userId", description = "鐢ㄦ埛Id", in = ParameterIn.QUERY),
- @Parameter(name = "roleIds", description = "瑙掕壊ID涓�", in = ParameterIn.QUERY)
- })
@SaCheckPermission("system:user:edit")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.GRANT)
@PutMapping("/authRole")
diff --git a/ruoyi-admin/src/main/resources/application.yml b/ruoyi-admin/src/main/resources/application.yml
index 3c11d01..74d251b 100644
--- a/ruoyi-admin/src/main/resources/application.yml
+++ b/ruoyi-admin/src/main/resources/application.yml
@@ -206,13 +206,8 @@
swagger-ui:
# 淇敼Swagger UI璺緞
path: /doc.html
- # 寮�鍚疭wagger UI鐣岄潰
- enabled: true
- api-docs:
- # 淇敼api-docs璺緞
- path: /v3/api-docs
- # 寮�鍚痑pi-docs
- enabled: true
+ # 鎸佷箙鍖栬璇佹暟鎹�
+ persistAuthorization: true
#杩欓噷瀹氫箟浜嗕袱涓垎缁勶紝鍙畾涔夊涓紝涔熷彲浠ヤ笉瀹氫箟
group-configs:
- group: 1.婕旂ず妯″潡
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java
index d86289d..ddfca7f 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java
@@ -2,7 +2,6 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.email.MailUtils;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -19,25 +18,35 @@
* @author Michelle.Chung
*/
@Validated
-@Tag(name ="閭欢鍙戦�佹渚�", description = "閭欢鍙戦�佹渚�")
+@Tag(name = "閭欢鍙戦�佹渚�", description = "閭欢鍙戦�佹渚�")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/mail")
public class MailController {
+ /**
+ * 鍙戦�侀偖浠�
+ *
+ * @param to 鎺ユ敹浜�
+ * @param subject 鏍囬
+ * @param text 鍐呭
+ */
@GetMapping("/sendSimpleMessage")
- public R<Void> sendSimpleMessage(@Parameter(name = "鎺ユ敹浜�") String to,
- @Parameter(name = "鏍囬") String subject,
- @Parameter(name = "鍐呭") String text) {
+ public R<Void> sendSimpleMessage(String to, String subject, String text) {
MailUtils.sendText(to, subject, text);
return R.ok();
}
+ /**
+ * 鍙戦�侀偖浠讹紙甯﹂檮浠讹級
+ *
+ * @param to 鎺ユ敹浜�
+ * @param subject 鏍囬
+ * @param text 鍐呭
+ * @param filePath 闄勪欢璺緞
+ */
@GetMapping("/sendMessageWithAttachment")
- public R<Void> sendMessageWithAttachment(@Parameter(name = "鎺ユ敹浜�") String to,
- @Parameter(name = "鏍囬") String subject,
- @Parameter(name = "鍐呭") String text,
- @Parameter(name = "闄勪欢璺緞") String filePath) {
+ public R<Void> sendMessageWithAttachment(String to, String subject, String text, String filePath) {
MailUtils.sendText(to, subject, text, new File(filePath));
return R.ok();
}
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java
index c2baa71..a345167 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java
@@ -2,7 +2,6 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.RedisUtils;
-import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.cache.annotation.CacheEvict;
@@ -21,7 +20,7 @@
*/
// 绫荤骇鍒� 缂撳瓨缁熶竴閰嶇疆
//@CacheConfig(cacheNames = "redissonCacheMap")
-@Tag(name ="spring-cache 婕旂ず妗堜緥", description = "spring-cache 婕旂ず妗堜緥")
+@Tag(name = "spring-cache 婕旂ず妗堜緥", description = "spring-cache 婕旂ず妗堜緥")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/cache")
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java
index 0e1bb84..69d231d 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java
@@ -20,7 +20,7 @@
*
* @author shenxinquan
*/
-@Tag(name ="娴嬭瘯鍒嗗竷寮忛攣鐨勬牱渚�", description = "娴嬭瘯鍒嗗竷寮忛攣鐨勬牱渚�")
+@Tag(name = "娴嬭瘯鍒嗗竷寮忛攣鐨勬牱渚�", description = "娴嬭瘯鍒嗗竷寮忛攣鐨勬牱渚�")
@Slf4j
@RestController
@RequestMapping("/demo/redisLock")
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisPubSubController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisPubSubController.java
index 344abc1..dae1036 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisPubSubController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisPubSubController.java
@@ -2,7 +2,6 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.RedisUtils;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
@@ -14,22 +13,33 @@
*
* @author Lion Li
*/
-@Tag(name ="Redis鍙戝竷璁㈤槄 婕旂ず妗堜緥", description = "Redis鍙戝竷璁㈤槄")
+@Tag(name = "Redis鍙戝竷璁㈤槄 婕旂ず妗堜緥", description = "Redis鍙戝竷璁㈤槄")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/redis/pubsub")
public class RedisPubSubController {
+ /**
+ * 鍙戝竷娑堟伅
+ *
+ * @param key 閫氶亾Key
+ * @param value 鍙戦�佸唴瀹�
+ */
@GetMapping("/pub")
- public R<Void> pub(@Parameter(name = "閫氶亾Key") String key, @Parameter(name = "鍙戦�佸唴瀹�") String value) {
+ public R<Void> pub(String key, String value) {
RedisUtils.publish(key, value, consumer -> {
System.out.println("鍙戝竷閫氶亾 => " + key + ", 鍙戦�佸�� => " + value);
});
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 璁㈤槄娑堟伅
+ *
+ * @param key 閫氶亾Key
+ */
@GetMapping("/sub")
- public R<Void> sub(@Parameter(name = "閫氶亾Key") String key) {
+ public R<Void> sub(String key) {
RedisUtils.subscribe(key, String.class, msg -> {
System.out.println("璁㈤槄閫氶亾 => " + key + ", 鎺ユ敹鍊� => " + msg);
});
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisRateLimiterController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisRateLimiterController.java
index abb59ac..39e5034 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisRateLimiterController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisRateLimiterController.java
@@ -15,7 +15,7 @@
*
* @author Lion Li
*/
-@Tag(name ="娴嬭瘯鍒嗗竷寮忛檺娴佹牱渚�", description = "娴嬭瘯鍒嗗竷寮忛檺娴佹牱渚�")
+@Tag(name = "娴嬭瘯鍒嗗竷寮忛檺娴佹牱渚�", description = "娴嬭瘯鍒嗗竷寮忛檺娴佹牱渚�")
@Slf4j
@RestController
@RequestMapping("/demo/rateLimiter")
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/SmsController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/SmsController.java
index a9c8061..a9c38a7 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/SmsController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/SmsController.java
@@ -4,7 +4,6 @@
import com.ruoyi.common.utils.spring.SpringUtils;
import com.ruoyi.sms.config.properties.SmsProperties;
import com.ruoyi.sms.core.SmsTemplate;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -23,7 +22,7 @@
* @version 4.2.0
*/
@Validated
-@Tag(name ="鐭俊婕旂ず妗堜緥", description = "鐭俊婕旂ず妗堜緥")
+@Tag(name = "鐭俊婕旂ず妗堜緥", description = "鐭俊婕旂ず妗堜緥")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/sms")
@@ -33,9 +32,14 @@
// private final SmsTemplate smsTemplate; // 鍙互浣跨敤spring娉ㄥ叆
// private final AliyunSmsTemplate smsTemplate; // 涔熷彲浠ユ敞鍏ユ煇涓巶瀹剁殑妯℃澘宸ュ叿
+ /**
+ * 鍙戦�佺煭淇liyun
+ *
+ * @param phones 鐢佃瘽鍙�
+ * @param templateId 妯℃澘ID
+ */
@GetMapping("/sendAliyun")
- public R<Object> sendAliyun(@Parameter(name = "鐢佃瘽鍙�") String phones,
- @Parameter(name = "妯℃澘ID") String templateId) {
+ public R<Object> sendAliyun(String phones, String templateId) {
if (!smsProperties.getEnabled()) {
return R.fail("褰撳墠绯荤粺娌℃湁寮�鍚煭淇″姛鑳斤紒");
}
@@ -49,9 +53,14 @@
return R.ok(send);
}
+ /**
+ * 鍙戦�佺煭淇encent
+ *
+ * @param phones 鐢佃瘽鍙�
+ * @param templateId 妯℃澘ID
+ */
@GetMapping("/sendTencent")
- public R<Object> sendTencent(@Parameter(name = "鐢佃瘽鍙�") String phones,
- @Parameter(name = "妯℃澘ID") String templateId) {
+ public R<Object> sendTencent(String phones, String templateId) {
if (!smsProperties.getEnabled()) {
return R.fail("褰撳墠绯荤粺娌℃湁寮�鍚煭淇″姛鑳斤紒");
}
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/Swagger3DemoController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/Swagger3DemoController.java
index af0e104..b044277 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/Swagger3DemoController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/Swagger3DemoController.java
@@ -1,10 +1,8 @@
package com.ruoyi.demo.controller;
import com.ruoyi.common.core.domain.R;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.Parameters;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestPart;
@@ -16,7 +14,7 @@
*
* @author Lion Li
*/
-@Tag(name ="婕旂ずswagger3鎺у埗鍣�", description = "婕旂ずswagger3鎺ュ彛")
+@Tag(name = "婕旂ずswagger3鎺у埗鍣�", description = "婕旂ずswagger3鎺ュ彛")
@RestController
@RequestMapping("/swagger/demo")
public class Swagger3DemoController {
@@ -24,11 +22,10 @@
/**
* 涓婁紶璇锋眰
* 蹇呴』浣跨敤 @RequestPart 娉ㄨВ鏍囨敞涓烘枃浠�
+ *
+ * @param file 鏂囦欢
*/
- @Parameters({
- @Parameter(name = "file", description = "鏂囦欢", in = ParameterIn.QUERY, required = true)
- })
- @PostMapping(value = "/upload")
+ @PostMapping(value = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public R<String> upload(@RequestPart("file") MultipartFile file) {
return R.ok("鎿嶄綔鎴愬姛", file.getOriginalFilename());
}
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestBatchController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestBatchController.java
index e821eaa..6f5e850 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestBatchController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestBatchController.java
@@ -21,7 +21,7 @@
* @author Lion Li
* @date 2021-05-30
*/
-@Tag(name ="娴嬭瘯鎵归噺鏂规硶", description = "娴嬭瘯鎵归噺鏂规硶")
+@Tag(name = "娴嬭瘯鎵归噺鏂规硶", description = "娴嬭瘯鎵归噺鏂规硶")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/batch")
@@ -65,7 +65,8 @@
testDemo.setOrderNum(-1);
testDemo.setTestKey("鎵归噺鏂板");
testDemo.setValue("娴嬭瘯鏂板");
- list.add(testDemo); }
+ list.add(testDemo);
+ }
testDemoMapper.insertBatch(list);
for (int i = 0; i < list.size(); i++) {
TestDemo testDemo = list.get(i);
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java
index 50bcbd0..b4b977a 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java
@@ -20,11 +20,9 @@
import com.ruoyi.demo.domain.bo.TestDemoImportVo;
import com.ruoyi.demo.domain.vo.TestDemoVo;
import com.ruoyi.demo.service.ITestDemoService;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.Parameters;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
@@ -43,7 +41,7 @@
* @date 2021-07-26
*/
@Validated
-@Tag(name ="娴嬭瘯鍗曡〃鎺у埗鍣�", description = "娴嬭瘯鍗曡〃绠＄悊")
+@Tag(name = "娴嬭瘯鍗曡〃鎺у埗鍣�", description = "娴嬭瘯鍗曡〃绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/demo")
@@ -69,12 +67,14 @@
return iTestDemoService.customPageList(bo, pageQuery);
}
- @Parameters({
- @Parameter(name = "file", description = "瀵煎叆鏂囦欢", in = ParameterIn.QUERY, required = true),
- })
+ /**
+ * 瀵煎叆鏁版嵁
+ *
+ * @param file 瀵煎叆鏂囦欢
+ */
@Log(title = "娴嬭瘯鍗曡〃", businessType = BusinessType.IMPORT)
@SaCheckPermission("demo:demo:import")
- @PostMapping("/importData")
+ @PostMapping(value = "/importData", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public R<Void> importData(@RequestPart("file") MultipartFile file) throws Exception {
ExcelResult<TestDemoImportVo> excelResult = ExcelUtil.importExcel(file.getInputStream(), TestDemoImportVo.class, true);
List<TestDemoImportVo> volist = excelResult.getList();
@@ -100,12 +100,13 @@
/**
* 鑾峰彇娴嬭瘯鍗曡〃璇︾粏淇℃伅
+ *
+ * @param id 娴嬭瘯ID
*/
@SaCheckPermission("demo:demo:query")
@GetMapping("/{id}")
- public R<TestDemoVo> getInfo(@Parameter(name = "娴嬭瘯ID")
- @NotNull(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable("id") Long id) {
+ public R<TestDemoVo> getInfo(@NotNull(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable("id") Long id) {
return R.ok(iTestDemoService.queryById(id));
}
@@ -136,13 +137,14 @@
/**
* 鍒犻櫎娴嬭瘯鍗曡〃
+ *
+ * @param ids 娴嬭瘯ID涓�
*/
@SaCheckPermission("demo:demo:remove")
@Log(title = "娴嬭瘯鍗曡〃", businessType = BusinessType.DELETE)
@DeleteMapping("/{ids}")
- public R<Void> remove(@Parameter(name = "娴嬭瘯ID涓�")
- @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable Long[] ids) {
+ public R<Void> remove(@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable Long[] ids) {
return toAjax(iTestDemoService.deleteWithValidByIds(Arrays.asList(ids), true) ? 1 : 0);
}
}
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestExcelController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestExcelController.java
index b241cc8..95d307b 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestExcelController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestExcelController.java
@@ -20,7 +20,7 @@
*
* @author Lion Li
*/
-@Tag(name ="娴嬭瘯Excel鍔熻兘", description = "娴嬭瘯Excel鍔熻兘")
+@Tag(name = "娴嬭瘯Excel鍔熻兘", description = "娴嬭瘯Excel鍔熻兘")
@RestController
@RequestMapping("/demo/excel")
public class TestExcelController {
@@ -30,18 +30,18 @@
*/
@GetMapping("/exportTemplateOne")
public void exportTemplateOne(HttpServletResponse response) {
- Map<String,String> map = new HashMap<>();
- map.put("title","鍗曞垪琛ㄥ鏁版嵁");
- map.put("test1","鏁版嵁娴嬭瘯1");
- map.put("test2","鏁版嵁娴嬭瘯2");
- map.put("test3","鏁版嵁娴嬭瘯3");
- map.put("test4","鏁版嵁娴嬭瘯4");
- map.put("testTest","666");
+ Map<String, String> map = new HashMap<>();
+ map.put("title", "鍗曞垪琛ㄥ鏁版嵁");
+ map.put("test1", "鏁版嵁娴嬭瘯1");
+ map.put("test2", "鏁版嵁娴嬭瘯2");
+ map.put("test3", "鏁版嵁娴嬭瘯3");
+ map.put("test4", "鏁版嵁娴嬭瘯4");
+ map.put("testTest", "666");
List<TestObj> list = new ArrayList<>();
list.add(new TestObj("鍗曞垪琛ㄦ祴璇�1", "鍒楄〃娴嬭瘯1", "鍒楄〃娴嬭瘯2", "鍒楄〃娴嬭瘯3", "鍒楄〃娴嬭瘯4"));
list.add(new TestObj("鍗曞垪琛ㄦ祴璇�2", "鍒楄〃娴嬭瘯5", "鍒楄〃娴嬭瘯6", "鍒楄〃娴嬭瘯7", "鍒楄〃娴嬭瘯8"));
list.add(new TestObj("鍗曞垪琛ㄦ祴璇�3", "鍒楄〃娴嬭瘯9", "鍒楄〃娴嬭瘯10", "鍒楄〃娴嬭瘯11", "鍒楄〃娴嬭瘯12"));
- ExcelUtil.exportTemplate(CollUtil.newArrayList(map,list),"鍗曞垪琛�.xlsx", "excel/鍗曞垪琛�.xlsx", response);
+ ExcelUtil.exportTemplate(CollUtil.newArrayList(map, list), "鍗曞垪琛�.xlsx", "excel/鍗曞垪琛�.xlsx", response);
}
/**
@@ -49,12 +49,12 @@
*/
@GetMapping("/exportTemplateMuliti")
public void exportTemplateMuliti(HttpServletResponse response) {
- Map<String,String> map = new HashMap<>();
- map.put("title1","鏍囬1");
- map.put("title2","鏍囬2");
- map.put("title3","鏍囬3");
- map.put("title4","鏍囬4");
- map.put("author","Lion Li");
+ Map<String, String> map = new HashMap<>();
+ map.put("title1", "鏍囬1");
+ map.put("title2", "鏍囬2");
+ map.put("title3", "鏍囬3");
+ map.put("title4", "鏍囬4");
+ map.put("author", "Lion Li");
List<TestObj1> list1 = new ArrayList<>();
list1.add(new TestObj1("list1娴嬭瘯1", "list1娴嬭瘯2", "list1娴嬭瘯3"));
list1.add(new TestObj1("list1娴嬭瘯4", "list1娴嬭瘯5", "list1娴嬭瘯6"));
@@ -69,12 +69,12 @@
list4.add(new TestObj1("list4娴嬭瘯4", "list4娴嬭瘯5", "list4娴嬭瘯6"));
list4.add(new TestObj1("list4娴嬭瘯7", "list4娴嬭瘯8", "list4娴嬭瘯9"));
list4.add(new TestObj1("list4娴嬭瘯10", "list4娴嬭瘯11", "list4娴嬭瘯12"));
- Map<String,Object> multiListMap = new HashMap<>();
- multiListMap.put("map",map);
- multiListMap.put("data1",list1);
- multiListMap.put("data2",list2);
- multiListMap.put("data3",list3);
- multiListMap.put("data4",list4);
+ Map<String, Object> multiListMap = new HashMap<>();
+ multiListMap.put("map", map);
+ multiListMap.put("data1", list1);
+ multiListMap.put("data2", list2);
+ multiListMap.put("data3", list3);
+ multiListMap.put("data4", list4);
ExcelUtil.exportTemplateMultiList(multiListMap, "澶氬垪琛�.xlsx", "excel/澶氬垪琛�.xlsx", response);
}
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java
index a004463..adb7f6f 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java
@@ -2,7 +2,6 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.MessageUtils;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.Data;
import org.hibernate.validator.constraints.Range;
@@ -21,7 +20,7 @@
* @author Lion Li
*/
@Validated
-@Tag(name ="娴嬭瘯鍥介檯鍖栨帶鍒跺櫒", description = "娴嬭瘯鍥介檯鍖栫鐞�")
+@Tag(name = "娴嬭瘯鍥介檯鍖栨帶鍒跺櫒", description = "娴嬭瘯鍥介檯鍖栫鐞�")
@RestController
@RequestMapping("/demo/i18n")
public class TestI18nController {
@@ -31,9 +30,11 @@
* code涓� messages.properties 涓殑 key
* <p>
* 娴嬭瘯浣跨敤 user.register.success
+ *
+ * @param code 鍥介檯鍖朿ode
*/
@GetMapping()
- public R<Void> get(@Parameter(name = "鍥介檯鍖朿ode") String code) {
+ public R<Void> get(String code) {
return R.ok(MessageUtils.message(code));
}
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java
index 9b7f34a..53a56d8 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java
@@ -20,7 +20,7 @@
* @version 3.6.0
* @see com.ruoyi.common.core.service.SensitiveService
*/
-@Tag(name ="娴嬭瘯鏁版嵁鑴辨晱鎺у埗鍣�", description = "娴嬭瘯鏁版嵁鑴辨晱绠＄悊")
+@Tag(name = "娴嬭瘯鏁版嵁鑴辨晱鎺у埗鍣�", description = "娴嬭瘯鏁版嵁鑴辨晱绠＄悊")
@RestController
@RequestMapping("/demo/sensitive")
public class TestSensitiveController extends BaseController {
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java
index c6bad67..38e314b 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java
@@ -13,7 +13,6 @@
import com.ruoyi.demo.domain.bo.TestTreeBo;
import com.ruoyi.demo.domain.vo.TestTreeVo;
import com.ruoyi.demo.service.ITestTreeService;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@@ -32,7 +31,7 @@
* @date 2021-07-26
*/
@Validated
-@Tag(name ="娴嬭瘯鏍戣〃鎺у埗鍣�", description = "娴嬭瘯鏍戣〃绠＄悊")
+@Tag(name = "娴嬭瘯鏍戣〃鎺у埗鍣�", description = "娴嬭瘯鏍戣〃绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/tree")
@@ -63,12 +62,13 @@
/**
* 鑾峰彇娴嬭瘯鏍戣〃璇︾粏淇℃伅
+ *
+ * @param id 娴嬭瘯鏍慖D
*/
@SaCheckPermission("demo:tree:query")
@GetMapping("/{id}")
- public R<TestTreeVo> getInfo(@Parameter(name = "娴嬭瘯鏍慖D")
- @NotNull(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable("id") Long id) {
+ public R<TestTreeVo> getInfo(@NotNull(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable("id") Long id) {
return R.ok(iTestTreeService.queryById(id));
}
@@ -96,13 +96,14 @@
/**
* 鍒犻櫎娴嬭瘯鏍戣〃
+ *
+ * @param ids 娴嬭瘯鏍慖D涓�
*/
@SaCheckPermission("demo:tree:remove")
@Log(title = "娴嬭瘯鏍戣〃", businessType = BusinessType.DELETE)
@DeleteMapping("/{ids}")
- public R<Void> remove(@Parameter(name = "娴嬭瘯鏍慖D涓�")
- @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable Long[] ids) {
+ public R<Void> remove(@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable Long[] ids) {
return toAjax(iTestTreeService.deleteWithValidByIds(Arrays.asList(ids), true) ? 1 : 0);
}
}
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java
index a940c2c..6f921f5 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java
@@ -2,7 +2,6 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.QueueUtils;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
@@ -22,16 +21,21 @@
* @version 3.6.0
*/
@Slf4j
-@Tag(name ="鏈夌晫闃熷垪 婕旂ず妗堜緥", description = "鏈夌晫闃熷垪")
+@Tag(name = "鏈夌晫闃熷垪 婕旂ず妗堜緥", description = "鏈夌晫闃熷垪")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/queue/bounded")
public class BoundedQueueController {
+ /**
+ * 娣诲姞闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ * @param capacity 瀹归噺
+ */
@GetMapping("/add")
- public R<Void> add(@Parameter(name = "闃熷垪鍚�") String queueName,
- @Parameter(name = "瀹归噺") int capacity) {
+ public R<Void> add(String queueName, int capacity) {
// 鐢ㄥ畬浜嗕竴瀹氳閿�姣� 鍚﹀垯浼氫竴鐩村瓨鍦�
boolean b = QueueUtils.destroyBoundedQueueObject(queueName);
log.info("閫氶亾: {} , 鍒犻櫎: {}", queueName, b);
@@ -54,8 +58,13 @@
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 鍒犻櫎闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ */
@GetMapping("/remove")
- public R<Void> remove(@Parameter(name = "闃熷垪鍚�") String queueName) {
+ public R<Void> remove(String queueName) {
String data = "data-" + 5;
if (QueueUtils.removeBoundedQueueObject(queueName, data)) {
log.info("閫氶亾: {} , 鍒犻櫎鏁版嵁: {}", queueName, data);
@@ -65,8 +74,13 @@
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 鑾峰彇闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ */
@GetMapping("/get")
- public R<Void> get(@Parameter(name = "闃熷垪鍚�") String queueName) {
+ public R<Void> get(String queueName) {
String data;
do {
data = QueueUtils.getBoundedQueueObject(queueName);
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java
index 0abcc4b..32067e5 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java
@@ -2,7 +2,6 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.QueueUtils;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
@@ -25,14 +24,19 @@
* @version 3.6.0
*/
@Slf4j
-@Tag(name ="寤惰繜闃熷垪 婕旂ず妗堜緥", description = "寤惰繜闃熷垪")
+@Tag(name = "寤惰繜闃熷垪 婕旂ず妗堜緥", description = "寤惰繜闃熷垪")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/queue/delayed")
public class DelayedQueueController {
+ /**
+ * 璁㈤槄闃熷垪
+ *
+ * @param queueName 闃熷垪鍚�
+ */
@GetMapping("/subscribe")
- public R<Void> subscribe(@Parameter(name = "闃熷垪鍚�") String queueName) {
+ public R<Void> subscribe(String queueName) {
log.info("閫氶亾: {} 鐩戝惉涓�......", queueName);
// 椤圭洰鍒濆鍖栬缃竴娆″嵆鍙�
QueueUtils.subscribeBlockingQueue(queueName, (String orderNum) -> {
@@ -42,19 +46,29 @@
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 娣诲姞闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ * @param orderNum 璁㈠崟鍙�
+ * @param time 寤惰繜鏃堕棿(绉�)
+ */
@GetMapping("/add")
- public R<Void> add(@Parameter(name = "闃熷垪鍚�") String queueName,
- @Parameter(name = "璁㈠崟鍙�") String orderNum,
- @Parameter(name = "寤惰繜鏃堕棿(绉�)") Long time) {
+ public R<Void> add(String queueName, String orderNum, Long time) {
QueueUtils.addDelayedQueueObject(queueName, orderNum, time, TimeUnit.SECONDS);
// 瑙傚療鍙戦�佹椂闂�
log.info("閫氶亾: {} , 鍙戦�佹暟鎹�: {}", queueName, orderNum);
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 鍒犻櫎闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ * @param orderNum 璁㈠崟鍙�
+ */
@GetMapping("/remove")
- public R<Void> remove(@Parameter(name = "闃熷垪鍚�") String queueName,
- @Parameter(name = "璁㈠崟鍙�") String orderNum) {
+ public R<Void> remove(String queueName, String orderNum) {
if (QueueUtils.removeDelayedQueueObject(queueName, orderNum)) {
log.info("閫氶亾: {} , 鍒犻櫎鏁版嵁: {}", queueName, orderNum);
} else {
@@ -63,8 +77,13 @@
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 閿�姣侀槦鍒�
+ *
+ * @param queueName 闃熷垪鍚�
+ */
@GetMapping("/destroy")
- public R<Void> destroy(@Parameter(name = "闃熷垪鍚�") String queueName) {
+ public R<Void> destroy(String queueName) {
// 鐢ㄥ畬浜嗕竴瀹氳閿�姣� 鍚﹀垯浼氫竴鐩村瓨鍦�
QueueUtils.destroyDelayedQueue(queueName);
return R.ok("鎿嶄綔鎴愬姛");
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/PriorityQueueController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/PriorityQueueController.java
index 1651631..1e7425f 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/PriorityQueueController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/PriorityQueueController.java
@@ -3,7 +3,6 @@
import cn.hutool.core.util.RandomUtil;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.QueueUtils;
-import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
@@ -23,14 +22,19 @@
* @version 3.6.0
*/
@Slf4j
-@Tag(name ="浼樺厛闃熷垪 婕旂ず妗堜緥", description = "浼樺厛闃熷垪")
+@Tag(name = "浼樺厛闃熷垪 婕旂ず妗堜緥", description = "浼樺厛闃熷垪")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/queue/priority")
public class PriorityQueueController {
+ /**
+ * 娣诲姞闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ */
@GetMapping("/add")
- public R<Void> add(@Parameter(name = "闃熷垪鍚�") String queueName) {
+ public R<Void> add(String queueName) {
// 鐢ㄥ畬浜嗕竴瀹氳閿�姣� 鍚﹀垯浼氫竴鐩村瓨鍦�
boolean b = QueueUtils.destroyPriorityQueueObject(queueName);
log.info("閫氶亾: {} , 鍒犻櫎: {}", queueName, b);
@@ -56,10 +60,15 @@
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 鍒犻櫎闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ * @param name 瀵硅薄鍚�
+ * @param orderNum 鎺掑簭鍙�
+ */
@GetMapping("/remove")
- public R<Void> remove(@Parameter(name = "闃熷垪鍚�") String queueName,
- @Parameter(name = "瀵硅薄鍚�") String name,
- @Parameter(name = "鎺掑簭鍙�") Integer orderNum) {
+ public R<Void> remove(String queueName, String name, Integer orderNum) {
PriorityDemo data = new PriorityDemo();
data.setName(name);
data.setOrderNum(orderNum);
@@ -71,8 +80,13 @@
return R.ok("鎿嶄綔鎴愬姛");
}
+ /**
+ * 鑾峰彇闃熷垪鏁版嵁
+ *
+ * @param queueName 闃熷垪鍚�
+ */
@GetMapping("/get")
- public R<Void> get(@Parameter(name = "闃熷垪鍚�") String queueName) {
+ public R<Void> get(String queueName) {
PriorityDemo data;
do {
data = QueueUtils.getPriorityQueueObject(queueName);
diff --git a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
index c677378..271f01f 100644
--- a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
+++ b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
@@ -3,6 +3,7 @@
import com.ruoyi.framework.config.properties.SwaggerProperties;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
import lombok.RequiredArgsConstructor;
import org.springdoc.core.SpringDocConfiguration;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
@@ -10,6 +11,9 @@
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
+
+import java.util.ArrayList;
+import java.util.List;
/**
* Swagger 鏂囨。閰嶇疆
@@ -37,6 +41,9 @@
openApi.tags(swaggerProperties.getTags());
openApi.paths(swaggerProperties.getPaths());
openApi.components(swaggerProperties.getComponents());
+ List<SecurityRequirement> list = new ArrayList<>();
+ list.add(new SecurityRequirement().addList("apikey"));
+ openApi.security(list);
return openApi;
}
diff --git a/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java b/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java
index d8c405e..7a20df1 100644
--- a/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java
+++ b/ruoyi-generator/src/main/java/com/ruoyi/generator/controller/GenController.java
@@ -48,6 +48,8 @@
/**
* 淇敼浠ｇ爜鐢熸垚涓氬姟
+ *
+ * @param tableId 琛↖D
*/
@SaCheckPermission("tool:gen:query")
@GetMapping(value = "/{tableId}")
@@ -73,6 +75,8 @@
/**
* 鏌ヨ鏁版嵁琛ㄥ瓧娈靛垪琛�
+ *
+ * @param tableId 琛↖D
*/
@SaCheckPermission("tool:gen:list")
@GetMapping(value = "/column/{tableId}")
@@ -86,6 +90,8 @@
/**
* 瀵煎叆琛ㄧ粨鏋勶紙淇濆瓨锛�
+ *
+ * @param tables 琛ㄥ悕涓�
*/
@SaCheckPermission("tool:gen:import")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.IMPORT)
@@ -112,6 +118,8 @@
/**
* 鍒犻櫎浠ｇ爜鐢熸垚
+ *
+ * @param tableIds 琛↖D涓�
*/
@SaCheckPermission("tool:gen:remove")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.DELETE)
@@ -123,6 +131,8 @@
/**
* 棰勮浠ｇ爜
+ *
+ * @param tableId 琛↖D
*/
@SaCheckPermission("tool:gen:preview")
@GetMapping("/preview/{tableId}")
@@ -133,6 +143,8 @@
/**
* 鐢熸垚浠ｇ爜锛堜笅杞芥柟寮忥級
+ *
+ * @param tableName 琛ㄥ悕
*/
@SaCheckPermission("tool:gen:code")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.GENCODE)
@@ -144,6 +156,8 @@
/**
* 鐢熸垚浠ｇ爜锛堣嚜瀹氫箟璺緞锛�
+ *
+ * @param tableName 琛ㄥ悕
*/
@SaCheckPermission("tool:gen:code")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.GENCODE)
@@ -155,6 +169,8 @@
/**
* 鍚屾鏁版嵁搴�
+ *
+ * @param tableName 琛ㄥ悕
*/
@SaCheckPermission("tool:gen:edit")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.UPDATE)
@@ -166,6 +182,8 @@
/**
* 鎵归噺鐢熸垚浠ｇ爜
+ *
+ * @param tables 琛ㄥ悕涓�
*/
@SaCheckPermission("tool:gen:code")
@Log(title = "浠ｇ爜鐢熸垚", businessType = BusinessType.GENCODE)
diff --git a/ruoyi-generator/src/main/resources/vm/java/controller.java.vm b/ruoyi-generator/src/main/resources/vm/java/controller.java.vm
index 5b30764..550be92 100644
--- a/ruoyi-generator/src/main/resources/vm/java/controller.java.vm
+++ b/ruoyi-generator/src/main/resources/vm/java/controller.java.vm
@@ -73,12 +73,13 @@
/**
* 鑾峰彇${functionName}璇︾粏淇℃伅
+ *
+ * @param ${pkColumn.javaField} 涓婚敭
*/
@SaCheckPermission("${permissionPrefix}:query")
@GetMapping("/{${pkColumn.javaField}}")
- public R<${ClassName}Vo> getInfo(@Parameter(name = "涓婚敭")
- @NotNull(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable("${pkColumn.javaField}") ${pkColumn.javaType} ${pkColumn.javaField}) {
+ public R<${ClassName}Vo> getInfo(@NotNull(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable ${pkColumn.javaType} ${pkColumn.javaField}) {
return R.ok(i${ClassName}Service.queryById(${pkColumn.javaField}));
}
@@ -106,13 +107,14 @@
/**
* 鍒犻櫎${functionName}
+ *
+ * @param ${pkColumn.javaField}s 涓婚敭涓�
*/
@SaCheckPermission("${permissionPrefix}:remove")
@Log(title = "${functionName}", businessType = BusinessType.DELETE)
@DeleteMapping("/{${pkColumn.javaField}s}")
- public R<Void> remove(@Parameter(name = "涓婚敭涓�")
- @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
- @PathVariable ${pkColumn.javaType}[] ${pkColumn.javaField}s) {
+ public R<Void> remove(@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable ${pkColumn.javaType}[] ${pkColumn.javaField}s) {
return toAjax(i${ClassName}Service.deleteWithValidByIds(Arrays.asList(${pkColumn.javaField}s), true) ? 1 : 0);
}
}
--
Gitblit v1.9.3