From d9e54388e7fde2462e8b7e0165c5e7da3f202593 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期四, 07 七月 2022 19:07:59 +0800
Subject: [PATCH] add 整合 springdoc-openapi-javadoc 基于代码注释生成文档
---
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysMenuController.java | 20 ++++++--------------
1 files changed, 6 insertions(+), 14 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 030363e..1e87e67 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,9 +10,8 @@
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 io.swagger.annotations.ApiParam;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@@ -27,7 +26,7 @@
* @author Lion Li
*/
@Validated
-@Api(value = "鑿滃崟淇℃伅鎺у埗鍣�", tags = {"鑿滃崟淇℃伅绠＄悊"})
+@Tag(name ="鑿滃崟淇℃伅鎺у埗鍣�", description = "鑿滃崟淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/menu")
@@ -38,7 +37,6 @@
/**
* 鑾峰彇鑿滃崟鍒楄〃
*/
- @ApiOperation("鑾峰彇鑿滃崟鍒楄〃")
@SaCheckPermission("system:menu:list")
@GetMapping("/list")
public R<List<SysMenu>> list(SysMenu menu) {
@@ -49,17 +47,15 @@
/**
* 鏍规嵁鑿滃崟缂栧彿鑾峰彇璇︾粏淇℃伅
*/
- @ApiOperation("鏍规嵁鑿滃崟缂栧彿鑾峰彇璇︾粏淇℃伅")
@SaCheckPermission("system:menu:query")
@GetMapping(value = "/{menuId}")
- public R<SysMenu> getInfo(@ApiParam("鑿滃崟ID") @PathVariable Long menuId) {
+ public R<SysMenu> getInfo(@Parameter(name = "鑿滃崟ID") @PathVariable Long menuId) {
return R.ok(menuService.selectMenuById(menuId));
}
/**
* 鑾峰彇鑿滃崟涓嬫媺鏍戝垪琛�
*/
- @ApiOperation("鑾峰彇鑿滃崟涓嬫媺鏍戝垪琛�")
@GetMapping("/treeselect")
public R<List<Tree<Long>>> treeselect(SysMenu menu) {
List<SysMenu> menus = menuService.selectMenuList(menu, getUserId());
@@ -69,9 +65,8 @@
/**
* 鍔犺浇瀵瑰簲瑙掕壊鑿滃崟鍒楄〃鏍�
*/
- @ApiOperation("鍔犺浇瀵瑰簲瑙掕壊鑿滃崟鍒楄〃鏍�")
@GetMapping(value = "/roleMenuTreeselect/{roleId}")
- public R<Map<String, Object>> roleMenuTreeselect(@ApiParam("瑙掕壊ID") @PathVariable("roleId") Long roleId) {
+ public R<Map<String, Object>> roleMenuTreeselect(@Parameter(name = "瑙掕壊ID") @PathVariable("roleId") Long roleId) {
List<SysMenu> menus = menuService.selectMenuList(getUserId());
Map<String, Object> ajax = new HashMap<>();
ajax.put("checkedKeys", menuService.selectMenuListByRoleId(roleId));
@@ -82,7 +77,6 @@
/**
* 鏂板鑿滃崟
*/
- @ApiOperation("鏂板鑿滃崟")
@SaCheckPermission("system:menu:add")
@Log(title = "鑿滃崟绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
@@ -98,7 +92,6 @@
/**
* 淇敼鑿滃崟
*/
- @ApiOperation("淇敼鑿滃崟")
@SaCheckPermission("system:menu:edit")
@Log(title = "鑿滃崟绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
@@ -116,11 +109,10 @@
/**
* 鍒犻櫎鑿滃崟
*/
- @ApiOperation("鍒犻櫎鑿滃崟")
@SaCheckPermission("system:menu:remove")
@Log(title = "鑿滃崟绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{menuId}")
- public R<Void> remove(@ApiParam("鑿滃崟ID") @PathVariable("menuId") Long menuId) {
+ public R<Void> remove(@Parameter(name = "鑿滃崟ID") @PathVariable("menuId") Long menuId) {
if (menuService.hasChildByMenuId(menuId)) {
return R.fail("瀛樺湪瀛愯彍鍗�,涓嶅厑璁稿垹闄�");
}
--
Gitblit v1.9.3