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/SysRoleController.java | 39 ++++++++++++++-------------------------
1 files changed, 14 insertions(+), 25 deletions(-)
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 5d9a206..fc0e5a7 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
@@ -5,8 +5,8 @@
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.constant.UserConstants;
import com.ruoyi.common.core.controller.BaseController;
-import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.domain.PageQuery;
+import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.domain.entity.SysRole;
import com.ruoyi.common.core.domain.entity.SysUser;
import com.ruoyi.common.core.domain.model.LoginUser;
@@ -18,7 +18,10 @@
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
import com.ruoyi.system.service.SysPermissionService;
-import io.swagger.annotations.*;
+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;
import org.springframework.web.bind.annotation.*;
@@ -32,7 +35,7 @@
* @author Lion Li
*/
@Validated
-@Api(value = "瑙掕壊淇℃伅鎺у埗鍣�", tags = {"瑙掕壊淇℃伅绠＄悊"})
+@Tag(name ="瑙掕壊淇℃伅鎺у埗鍣�", description = "瑙掕壊淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/role")
@@ -42,14 +45,12 @@
private final ISysUserService userService;
private final SysPermissionService permissionService;
- @ApiOperation("鏌ヨ瑙掕壊淇℃伅鍒楄〃")
@SaCheckPermission("system:role:list")
@GetMapping("/list")
public TableDataInfo<SysRole> list(SysRole role, PageQuery pageQuery) {
return roleService.selectPageRoleList(role, pageQuery);
}
- @ApiOperation("瀵煎嚭瑙掕壊淇℃伅鍒楄〃")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:role:export")
@PostMapping("/export")
@@ -61,10 +62,9 @@
/**
* 鏍规嵁瑙掕壊缂栧彿鑾峰彇璇︾粏淇℃伅
*/
- @ApiOperation("鏍规嵁瑙掕壊缂栧彿鑾峰彇璇︾粏淇℃伅")
@SaCheckPermission("system:role:query")
@GetMapping(value = "/{roleId}")
- public R<SysRole> getInfo(@ApiParam("瑙掕壊ID") @PathVariable Long roleId) {
+ public R<SysRole> getInfo(@Parameter(name = "瑙掕壊ID") @PathVariable Long roleId) {
roleService.checkRoleDataScope(roleId);
return R.ok(roleService.selectRoleById(roleId));
}
@@ -72,7 +72,6 @@
/**
* 鏂板瑙掕壊
*/
- @ApiOperation("鏂板瑙掕壊")
@SaCheckPermission("system:role:add")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
@@ -89,7 +88,6 @@
/**
* 淇敼淇濆瓨瑙掕壊
*/
- @ApiOperation("淇敼淇濆瓨瑙掕壊")
@SaCheckPermission("system:role:edit")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
@@ -118,7 +116,6 @@
/**
* 淇敼淇濆瓨鏁版嵁鏉冮檺
*/
- @ApiOperation("淇敼淇濆瓨鏁版嵁鏉冮檺")
@SaCheckPermission("system:role:edit")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping("/dataScope")
@@ -131,7 +128,6 @@
/**
* 鐘舵�佷慨鏀�
*/
- @ApiOperation("鐘舵�佷慨鏀�")
@SaCheckPermission("system:role:edit")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping("/changeStatus")
@@ -144,18 +140,16 @@
/**
* 鍒犻櫎瑙掕壊
*/
- @ApiOperation("鍒犻櫎瑙掕壊")
@SaCheckPermission("system:role:remove")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{roleIds}")
- public R<Void> remove(@ApiParam("宀椾綅ID涓�") @PathVariable Long[] roleIds) {
+ public R<Void> remove(@Parameter(name = "瑙掕壊ID涓�") @PathVariable Long[] roleIds) {
return toAjax(roleService.deleteRoleByIds(roleIds));
}
/**
* 鑾峰彇瑙掕壊閫夋嫨妗嗗垪琛�
*/
- @ApiOperation("鑾峰彇瑙掕壊閫夋嫨妗嗗垪琛�")
@SaCheckPermission("system:role:query")
@GetMapping("/optionselect")
public R<List<SysRole>> optionselect() {
@@ -165,7 +159,6 @@
/**
* 鏌ヨ宸插垎閰嶇敤鎴疯鑹插垪琛�
*/
- @ApiOperation("鏌ヨ宸插垎閰嶇敤鎴疯鑹插垪琛�")
@SaCheckPermission("system:role:list")
@GetMapping("/authUser/allocatedList")
public TableDataInfo<SysUser> allocatedList(SysUser user, PageQuery pageQuery) {
@@ -175,7 +168,6 @@
/**
* 鏌ヨ鏈垎閰嶇敤鎴疯鑹插垪琛�
*/
- @ApiOperation("鏌ヨ鏈垎閰嶇敤鎴疯鑹插垪琛�")
@SaCheckPermission("system:role:list")
@GetMapping("/authUser/unallocatedList")
public TableDataInfo<SysUser> unallocatedList(SysUser user, PageQuery pageQuery) {
@@ -185,7 +177,6 @@
/**
* 鍙栨秷鎺堟潈鐢ㄦ埛
*/
- @ApiOperation("鍙栨秷鎺堟潈鐢ㄦ埛")
@SaCheckPermission("system:role:edit")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.GRANT)
@PutMapping("/authUser/cancel")
@@ -196,10 +187,9 @@
/**
* 鎵归噺鍙栨秷鎺堟潈鐢ㄦ埛
*/
- @ApiOperation("鎵归噺鍙栨秷鎺堟潈鐢ㄦ埛")
- @ApiImplicitParams({
- @ApiImplicitParam(name = "roleId", value = "瑙掕壊ID", paramType = "query", dataTypeClass = String.class),
- @ApiImplicitParam(name = "userIds", value = "鐢ㄦ埛ID涓�", paramType = "query", dataTypeClass = String.class)
+ @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)
@@ -211,10 +201,9 @@
/**
* 鎵归噺閫夋嫨鐢ㄦ埛鎺堟潈
*/
- @ApiOperation("鎵归噺閫夋嫨鐢ㄦ埛鎺堟潈")
- @ApiImplicitParams({
- @ApiImplicitParam(name = "roleId", value = "瑙掕壊ID", paramType = "query", dataTypeClass = String.class),
- @ApiImplicitParam(name = "userIds", value = "鐢ㄦ埛ID涓�", paramType = "query", dataTypeClass = String.class)
+ @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)
--
Gitblit v1.9.3