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/SysMenuController.java | 72 +++++++++++++++++-------------------
1 files changed, 34 insertions(+), 38 deletions(-)
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 d679bfb..b0537f2 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
@@ -4,10 +4,14 @@
import com.ruoyi.common.constant.UserConstants;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.AjaxResult;
+import com.ruoyi.common.core.domain.TreeSelect;
import com.ruoyi.common.core.domain.entity.SysMenu;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.system.service.ISysMenuService;
+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;
@@ -20,22 +24,24 @@
/**
* 鑿滃崟淇℃伅
*
- * @author ruoyi
+ * @author Lion Li
*/
+@Validated
+@Api(value = "鑿滃崟淇℃伅鎺у埗鍣�", tags = {"鑿滃崟淇℃伅绠＄悊"})
+@RequiredArgsConstructor(onConstructor_ = @Autowired)
@RestController
@RequestMapping("/system/menu")
-public class SysMenuController extends BaseController
-{
- @Autowired
- private ISysMenuService menuService;
+public class SysMenuController extends BaseController {
+
+ private final ISysMenuService menuService;
/**
* 鑾峰彇鑿滃崟鍒楄〃
*/
+ @ApiOperation("鑾峰彇鑿滃崟鍒楄〃")
@PreAuthorize("@ss.hasPermi('system:menu:list')")
@GetMapping("/list")
- public AjaxResult list(SysMenu menu)
- {
+ public AjaxResult<List<SysMenu>> list(SysMenu menu) {
List<SysMenu> menus = menuService.selectMenuList(menu, getUserId());
return AjaxResult.success(menus);
}
@@ -43,19 +49,19 @@
/**
* 鏍规嵁鑿滃崟缂栧彿鑾峰彇璇︾粏淇℃伅
*/
+ @ApiOperation("鏍规嵁鑿滃崟缂栧彿鑾峰彇璇︾粏淇℃伅")
@PreAuthorize("@ss.hasPermi('system:menu:query')")
@GetMapping(value = "/{menuId}")
- public AjaxResult getInfo(@PathVariable Long menuId)
- {
+ public AjaxResult<SysMenu> getInfo(@PathVariable Long menuId) {
return AjaxResult.success(menuService.selectMenuById(menuId));
}
/**
* 鑾峰彇鑿滃崟涓嬫媺鏍戝垪琛�
*/
+ @ApiOperation("鑾峰彇鑿滃崟涓嬫媺鏍戝垪琛�")
@GetMapping("/treeselect")
- public AjaxResult treeselect(SysMenu menu)
- {
+ public AjaxResult<List<TreeSelect>> treeselect(SysMenu menu) {
List<SysMenu> menus = menuService.selectMenuList(menu, getUserId());
return AjaxResult.success(menuService.buildMenuTreeSelect(menus));
}
@@ -63,11 +69,11 @@
/**
* 鍔犺浇瀵瑰簲瑙掕壊鑿滃崟鍒楄〃鏍�
*/
+ @ApiOperation("鍔犺浇瀵瑰簲瑙掕壊鑿滃崟鍒楄〃鏍�")
@GetMapping(value = "/roleMenuTreeselect/{roleId}")
- public AjaxResult roleMenuTreeselect(@PathVariable("roleId") Long roleId)
- {
- List<SysMenu> menus = menuService.selectMenuList(getUserId());
- Map<String,Object> ajax = new HashMap<>();
+ public AjaxResult<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));
ajax.put("menus", menuService.buildMenuTreeSelect(menus));
return AjaxResult.success(ajax);
@@ -76,17 +82,14 @@
/**
* 鏂板鑿滃崟
*/
+ @ApiOperation("鏂板鑿滃崟")
@PreAuthorize("@ss.hasPermi('system:menu:add')")
@Log(title = "鑿滃崟绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
- public AjaxResult add(@Validated @RequestBody SysMenu menu)
- {
- if (UserConstants.NOT_UNIQUE.equals(menuService.checkMenuNameUnique(menu)))
- {
+ public AjaxResult<Void> add(@Validated @RequestBody SysMenu menu) {
+ if (UserConstants.NOT_UNIQUE.equals(menuService.checkMenuNameUnique(menu))) {
return AjaxResult.error("鏂板鑿滃崟'" + menu.getMenuName() + "'澶辫触锛岃彍鍗曞悕绉板凡瀛樺湪");
- }
- else if (UserConstants.YES_FRAME.equals(menu.getIsFrame()) && !StringUtils.ishttp(menu.getPath()))
- {
+ } else if (UserConstants.YES_FRAME.equals(menu.getIsFrame()) && !StringUtils.ishttp(menu.getPath())) {
return AjaxResult.error("鏂板鑿滃崟'" + menu.getMenuName() + "'澶辫触锛屽湴鍧�蹇呴』浠ttp(s)://寮�澶�");
}
menu.setCreateBy(getUsername());
@@ -96,21 +99,16 @@
/**
* 淇敼鑿滃崟
*/
+ @ApiOperation("淇敼鑿滃崟")
@PreAuthorize("@ss.hasPermi('system:menu:edit')")
@Log(title = "鑿滃崟绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
- public AjaxResult edit(@Validated @RequestBody SysMenu menu)
- {
- if (UserConstants.NOT_UNIQUE.equals(menuService.checkMenuNameUnique(menu)))
- {
+ public AjaxResult<Void> edit(@Validated @RequestBody SysMenu menu) {
+ if (UserConstants.NOT_UNIQUE.equals(menuService.checkMenuNameUnique(menu))) {
return AjaxResult.error("淇敼鑿滃崟'" + menu.getMenuName() + "'澶辫触锛岃彍鍗曞悕绉板凡瀛樺湪");
- }
- else if (UserConstants.YES_FRAME.equals(menu.getIsFrame()) && !StringUtils.ishttp(menu.getPath()))
- {
+ } else if (UserConstants.YES_FRAME.equals(menu.getIsFrame()) && !StringUtils.ishttp(menu.getPath())) {
return AjaxResult.error("淇敼鑿滃崟'" + menu.getMenuName() + "'澶辫触锛屽湴鍧�蹇呴』浠ttp(s)://寮�澶�");
- }
- else if (menu.getMenuId().equals(menu.getParentId()))
- {
+ } else if (menu.getMenuId().equals(menu.getParentId())) {
return AjaxResult.error("淇敼鑿滃崟'" + menu.getMenuName() + "'澶辫触锛屼笂绾ц彍鍗曚笉鑳介�夋嫨鑷繁");
}
menu.setUpdateBy(getUsername());
@@ -120,17 +118,15 @@
/**
* 鍒犻櫎鑿滃崟
*/
+ @ApiOperation("鍒犻櫎鑿滃崟")
@PreAuthorize("@ss.hasPermi('system:menu:remove')")
@Log(title = "鑿滃崟绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{menuId}")
- public AjaxResult remove(@PathVariable("menuId") Long menuId)
- {
- if (menuService.hasChildByMenuId(menuId))
- {
+ public AjaxResult<Void> remove(@PathVariable("menuId") Long menuId) {
+ if (menuService.hasChildByMenuId(menuId)) {
return AjaxResult.error("瀛樺湪瀛愯彍鍗�,涓嶅厑璁稿垹闄�");
}
- if (menuService.checkMenuExistRole(menuId))
- {
+ if (menuService.checkMenuExistRole(menuId)) {
return AjaxResult.error("鑿滃崟宸插垎閰�,涓嶅厑璁稿垹闄�");
}
return toAjax(menuService.deleteMenuById(menuId));
--
Gitblit v1.9.3