From a6fb88d74c20cc28043d75e8a5097fce49cf9a78 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期五, 15 十月 2021 15:19:42 +0800
Subject: [PATCH] update [重大更新]全业务 增加 接口文档注解 格式化代码
---
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java | 60 +++++++++++++++++++++++++++++++-----------------------------
1 files changed, 31 insertions(+), 29 deletions(-)
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 ea5e7e5..42bba01 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
@@ -7,10 +7,12 @@
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.enums.BusinessType;
-import com.ruoyi.common.utils.SecurityUtils;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysConfig;
import com.ruoyi.system.service.ISysConfigService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.validation.annotation.Validated;
@@ -22,94 +24,94 @@
/**
* 鍙傛暟閰嶇疆 淇℃伅鎿嶄綔澶勭悊
*
- * @author ruoyi
+ * @author Lion Li
*/
+@Validated
+@Api(value = "鍙傛暟閰嶇疆鎺у埗鍣�", tags = {"鍙傛暟閰嶇疆绠＄悊"})
+@RequiredArgsConstructor(onConstructor_ = @Autowired)
@RestController
@RequestMapping("/system/config")
-public class SysConfigController extends BaseController
-{
- @Autowired
- private ISysConfigService configService;
+public class SysConfigController extends BaseController {
+
+ private final ISysConfigService configService;
/**
* 鑾峰彇鍙傛暟閰嶇疆鍒楄〃
*/
+ @ApiOperation("鑾峰彇鍙傛暟閰嶇疆鍒楄〃")
@PreAuthorize("@ss.hasPermi('system:config:list')")
@GetMapping("/list")
- public TableDataInfo list(SysConfig config)
- {
+ public TableDataInfo<SysConfig> list(SysConfig config) {
return configService.selectPageConfigList(config);
}
+ @ApiOperation("瀵煎嚭鍙傛暟閰嶇疆鍒楄〃")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.EXPORT)
@PreAuthorize("@ss.hasPermi('system:config:export')")
@GetMapping("/export")
- public void export(SysConfig config, HttpServletResponse response)
- {
+ public void export(SysConfig config, HttpServletResponse response) {
List<SysConfig> list = configService.selectConfigList(config);
- ExcelUtil.exportExcel(list, "鍙傛暟鏁版嵁", SysConfig.class, response);
+ ExcelUtil.exportExcel(list, "鍙傛暟鏁版嵁", SysConfig.class, response);
}
/**
* 鏍规嵁鍙傛暟缂栧彿鑾峰彇璇︾粏淇℃伅
*/
+ @ApiOperation("鏍规嵁鍙傛暟缂栧彿鑾峰彇璇︾粏淇℃伅")
@PreAuthorize("@ss.hasPermi('system:config:query')")
@GetMapping(value = "/{configId}")
- public AjaxResult getInfo(@PathVariable Long configId)
- {
+ public AjaxResult<SysConfig> getInfo(@PathVariable Long configId) {
return AjaxResult.success(configService.selectConfigById(configId));
}
/**
* 鏍规嵁鍙傛暟閿悕鏌ヨ鍙傛暟鍊�
*/
+ @ApiOperation("鏍规嵁鍙傛暟閿悕鏌ヨ鍙傛暟鍊�")
@GetMapping(value = "/configKey/{configKey}")
- public AjaxResult getConfigKey(@PathVariable String configKey)
- {
+ public AjaxResult<Void> getConfigKey(@PathVariable String configKey) {
return AjaxResult.success(configService.selectConfigByKey(configKey));
}
/**
* 鏂板鍙傛暟閰嶇疆
*/
+ @ApiOperation("鏂板鍙傛暟閰嶇疆")
@PreAuthorize("@ss.hasPermi('system:config:add')")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
@RepeatSubmit
- public AjaxResult add(@Validated @RequestBody SysConfig config)
- {
- if (UserConstants.NOT_UNIQUE.equals(configService.checkConfigKeyUnique(config)))
- {
+ public AjaxResult<Void> add(@Validated @RequestBody SysConfig config) {
+ if (UserConstants.NOT_UNIQUE.equals(configService.checkConfigKeyUnique(config))) {
return AjaxResult.error("鏂板鍙傛暟'" + config.getConfigName() + "'澶辫触锛屽弬鏁伴敭鍚嶅凡瀛樺湪");
}
- config.setCreateBy(SecurityUtils.getUsername());
+ config.setCreateBy(getUsername());
return toAjax(configService.insertConfig(config));
}
/**
* 淇敼鍙傛暟閰嶇疆
*/
+ @ApiOperation("淇敼鍙傛暟閰嶇疆")
@PreAuthorize("@ss.hasPermi('system:config:edit')")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
- public AjaxResult edit(@Validated @RequestBody SysConfig config)
- {
- if (UserConstants.NOT_UNIQUE.equals(configService.checkConfigKeyUnique(config)))
- {
+ public AjaxResult<Void> edit(@Validated @RequestBody SysConfig config) {
+ if (UserConstants.NOT_UNIQUE.equals(configService.checkConfigKeyUnique(config))) {
return AjaxResult.error("淇敼鍙傛暟'" + config.getConfigName() + "'澶辫触锛屽弬鏁伴敭鍚嶅凡瀛樺湪");
}
- config.setUpdateBy(SecurityUtils.getUsername());
+ config.setUpdateBy(getUsername());
return toAjax(configService.updateConfig(config));
}
/**
* 鍒犻櫎鍙傛暟閰嶇疆
*/
+ @ApiOperation("鍒犻櫎鍙傛暟閰嶇疆")
@PreAuthorize("@ss.hasPermi('system:config:remove')")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{configIds}")
- public AjaxResult remove(@PathVariable Long[] configIds)
- {
+ public AjaxResult<Void> remove(@PathVariable Long[] configIds) {
configService.deleteConfigByIds(configIds);
return success();
}
@@ -117,11 +119,11 @@
/**
* 鍒锋柊鍙傛暟缂撳瓨
*/
+ @ApiOperation("鍒锋柊鍙傛暟缂撳瓨")
@PreAuthorize("@ss.hasPermi('system:config:remove')")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.CLEAN)
@DeleteMapping("/refreshCache")
- public AjaxResult refreshCache()
- {
+ public AjaxResult<Void> refreshCache() {
configService.resetConfigCache();
return AjaxResult.success();
}
--
Gitblit v1.9.3