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/SysUserController.java | 35 +++++++++++++----------------------
1 files changed, 13 insertions(+), 22 deletions(-)
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 e618655..cb564b6 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,7 +26,10 @@
import com.ruoyi.system.service.ISysPostService;
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
-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.*;
@@ -44,7 +47,7 @@
* @author Lion Li
*/
@Validated
-@Api(value = "鐢ㄦ埛淇℃伅鎺у埗鍣�", tags = {"鐢ㄦ埛淇℃伅绠＄悊"})
+@Tag(name ="鐢ㄦ埛淇℃伅鎺у埗鍣�", description = "鐢ㄦ埛淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/user")
@@ -57,14 +60,12 @@
/**
* 鑾峰彇鐢ㄦ埛鍒楄〃
*/
- @ApiOperation("鑾峰彇鐢ㄦ埛鍒楄〃")
@SaCheckPermission("system:user:list")
@GetMapping("/list")
public TableDataInfo<SysUser> list(SysUser user, PageQuery pageQuery) {
return userService.selectPageUserList(user, pageQuery);
}
- @ApiOperation("瀵煎嚭鐢ㄦ埛鍒楄〃")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:user:export")
@PostMapping("/export")
@@ -82,9 +83,8 @@
ExcelUtil.exportExcel(listVo, "鐢ㄦ埛鏁版嵁", SysUserExportVo.class, response);
}
- @ApiOperation("瀵煎叆鐢ㄦ埛鍒楄〃")
- @ApiImplicitParams({
- @ApiImplicitParam(name = "file", value = "瀵煎叆鏂囦欢", dataType = "java.io.File", required = true),
+ @Parameters({
+ @Parameter(name = "file", description = "瀵煎叆鏂囦欢", required = true),
})
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.IMPORT)
@SaCheckPermission("system:user:import")
@@ -94,7 +94,6 @@
return R.ok(result.getAnalysis());
}
- @ApiOperation("涓嬭浇瀵煎叆妯℃澘")
@PostMapping("/importTemplate")
public void importTemplate(HttpServletResponse response) {
ExcelUtil.exportExcel(new ArrayList<>(), "鐢ㄦ埛鏁版嵁", SysUserImportVo.class, response);
@@ -103,10 +102,9 @@
/**
* 鏍规嵁鐢ㄦ埛缂栧彿鑾峰彇璇︾粏淇℃伅
*/
- @ApiOperation("鏍规嵁鐢ㄦ埛缂栧彿鑾峰彇璇︾粏淇℃伅")
@SaCheckPermission("system:user:query")
@GetMapping(value = {"/", "/{userId}"})
- public R<Map<String, Object>> getInfo(@ApiParam("鐢ㄦ埛ID") @PathVariable(value = "userId", required = false) Long userId) {
+ public R<Map<String, Object>> getInfo(@Parameter(name = "鐢ㄦ埛ID") @PathVariable(value = "userId", required = false) Long userId) {
userService.checkUserDataScope(userId);
Map<String, Object> ajax = new HashMap<>();
List<SysRole> roles = roleService.selectRoleAll();
@@ -124,7 +122,6 @@
/**
* 鏂板鐢ㄦ埛
*/
- @ApiOperation("鏂板鐢ㄦ埛")
@SaCheckPermission("system:user:add")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
@@ -145,7 +142,6 @@
/**
* 淇敼鐢ㄦ埛
*/
- @ApiOperation("淇敼鐢ㄦ埛")
@SaCheckPermission("system:user:edit")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
@@ -165,11 +161,10 @@
/**
* 鍒犻櫎鐢ㄦ埛
*/
- @ApiOperation("鍒犻櫎鐢ㄦ埛")
@SaCheckPermission("system:user:remove")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{userIds}")
- public R<Void> remove(@ApiParam("瑙掕壊ID涓�") @PathVariable Long[] userIds) {
+ public R<Void> remove(@Parameter(name = "瑙掕壊ID涓�") @PathVariable Long[] userIds) {
if (ArrayUtil.contains(userIds, getUserId())) {
return R.fail("褰撳墠鐢ㄦ埛涓嶈兘鍒犻櫎");
}
@@ -179,7 +174,6 @@
/**
* 閲嶇疆瀵嗙爜
*/
- @ApiOperation("閲嶇疆瀵嗙爜")
@SaCheckPermission("system:user:resetPwd")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping("/resetPwd")
@@ -193,7 +187,6 @@
/**
* 鐘舵�佷慨鏀�
*/
- @ApiOperation("鐘舵�佷慨鏀�")
@SaCheckPermission("system:user:edit")
@Log(title = "鐢ㄦ埛绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping("/changeStatus")
@@ -206,10 +199,9 @@
/**
* 鏍规嵁鐢ㄦ埛缂栧彿鑾峰彇鎺堟潈瑙掕壊
*/
- @ApiOperation("鏍规嵁鐢ㄦ埛缂栧彿鑾峰彇鎺堟潈瑙掕壊")
@SaCheckPermission("system:user:query")
@GetMapping("/authRole/{userId}")
- public R<Map<String, Object>> authRole(@ApiParam("鐢ㄦ埛ID") @PathVariable("userId") Long userId) {
+ public R<Map<String, Object>> authRole(@Parameter(name = "鐢ㄦ埛ID") @PathVariable("userId") Long userId) {
SysUser user = userService.selectUserById(userId);
List<SysRole> roles = roleService.selectRolesByUserId(userId);
Map<String, Object> ajax = new HashMap<>();
@@ -221,10 +213,9 @@
/**
* 鐢ㄦ埛鎺堟潈瑙掕壊
*/
- @ApiOperation("鐢ㄦ埛鎺堟潈瑙掕壊")
- @ApiImplicitParams({
- @ApiImplicitParam(name = "userId", value = "鐢ㄦ埛Id", paramType = "query", dataTypeClass = String.class),
- @ApiImplicitParam(name = "roleIds", value = "瑙掕壊ID涓�", paramType = "query", dataTypeClass = String.class)
+ @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)
--
Gitblit v1.9.3