tongtong/youlai-boot
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: 接口文档请求头 Authorization 参数配置全局，接口移除 @SecurityRequirement

Browse Source
This commit is contained in:
haoxr
2023-10-17 21:53:13 +08:00
parent 36894b16f1
commit 5d59c3b5f9
5 changed files with 35 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/main/java/com/youlai/system/common/constant/SystemConstants.java
View File

@@ -24,5 +24,10 @@ public interface SystemConstants {
*/
String ROOT_ROLE_CODE = "ROOT";
/**
* 超级管理员用户名
*/
String ROOT_USER_NAME = "root";
}

4
src/main/java/com/youlai/system/controller/FileController.java
View File

@@ -21,7 +21,7 @@ public class FileController {
private final OssService ossService;
@PostMapping
@Operation(summary = "文件上传", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "文件上传")
public Result<FileInfo> uploadFile(
@Parameter(description ="表单文件对象") @RequestParam(value = "file") MultipartFile file
) {
@@ -30,7 +30,7 @@ public class FileController {
}
@DeleteMapping
@Operation(summary = "文件删除", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "文件删除")
@SneakyThrows
public Result deleteFile(
@Parameter(description ="文件路径") @RequestParam String filePath

12
src/main/java/com/youlai/system/controller/SysDeptController.java
View File

@@ -31,7 +31,7 @@ import java.util.List;
@RequiredArgsConstructor
public class SysDeptController {
private final SysDeptService deptService;
@Operation(summary = "获取部门列表", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "获取部门列表")
@GetMapping
public Result<List<DeptVO>> listDepartments(
@ParameterObject DeptQuery queryParams
@@ -40,14 +40,14 @@ public class SysDeptController {
return Result.success(list);
}
@Operation(summary = "获取部门下拉选项", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "获取部门下拉选项")
@GetMapping("/options")
public Result<List<Option>> listDeptOptions() {
List<Option> list = deptService.listDeptOptions();
return Result.success(list);
}
@Operation(summary = "获取部门表单数据", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "获取部门表单数据")
@GetMapping("/{deptId}/form")
public Result<DeptForm> getDeptForm(
@Parameter(description ="部门ID") @PathVariable Long deptId
@@ -56,7 +56,7 @@ public class SysDeptController {
return Result.success(deptForm);
}
@Operation(summary = "新增部门", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "新增部门")
@PostMapping
@PreAuthorize("@ss.hasPerm('sys:dept:add')")
@PreventDuplicateSubmit
@@ -67,7 +67,7 @@ public class SysDeptController {
return Result.success(id);
}
@Operation(summary = "修改部门", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "修改部门")
@PutMapping(value = "/{deptId}")
@PreAuthorize("@ss.hasPerm('sys:dept:edit')")
public Result updateDept(
@@ -78,7 +78,7 @@ public class SysDeptController {
return Result.success(deptId);
}
@Operation(summary = "删除部门", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "删除部门")
@DeleteMapping("/{ids}")
@PreAuthorize("@ss.hasPerm('sys:dept:delete')")
public Result deleteDepartments(

22
src/main/java/com/youlai/system/controller/SysDictController.java
View File

@@ -34,7 +34,7 @@ public class SysDictController {
private final SysDictTypeService dictTypeService;
@Operation(summary = "字典分页列表", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "字典分页列表")
@GetMapping("/page")
public PageResult<DictPageVO> getDictPage(
@ParameterObject DictPageQuery queryParams
@@ -43,7 +43,7 @@ public class SysDictController {
return PageResult.success(result);
}
@Operation(summary = "字典数据表单数据", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "字典数据表单数据")
@GetMapping("/{id}/form")
public Result<DictForm> getDictForm(
@Parameter(description ="字典ID") @PathVariable Long id
@@ -52,7 +52,7 @@ public class SysDictController {
return Result.success(formData);
}
@Operation(summary = "新增字典", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "新增字典")
@PostMapping
@PreAuthorize("@ss.hasPerm('sys:dict:add')")
@PreventDuplicateSubmit
@@ -63,7 +63,7 @@ public class SysDictController {
return Result.judge(result);
}
@Operation(summary = "修改字典", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "修改字典")
@PutMapping("/{id}")
@PreAuthorize("@ss.hasPerm('sys:dict:edit')")
public Result updateDict(
@@ -74,7 +74,7 @@ public class SysDictController {
return Result.judge(status);
}
@Operation(summary = "删除字典", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "删除字典")
@DeleteMapping("/{ids}")
@PreAuthorize("@ss.hasPerm('sys:dict:delete')")
public Result deleteDict(
@@ -85,7 +85,7 @@ public class SysDictController {
}
@Operation(summary = "字典下拉列表", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "字典下拉列表")
@GetMapping("/{typeCode}/options")
public Result<List<Option>> listDictOptions(
@Parameter(description ="字典类型编码") @PathVariable String typeCode
@@ -96,7 +96,7 @@ public class SysDictController {
/*----------------------------------------------------*/
@Operation(summary = "字典类型分页列表", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "字典类型分页列表")
@GetMapping("/types/page")
public PageResult<DictTypePageVO> getDictTypePage(
@ParameterObject DictTypePageQuery queryParams
@@ -105,7 +105,7 @@ public class SysDictController {
return PageResult.success(result);
}
@Operation(summary = "字典类型表单数据", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "字典类型表单数据")
@GetMapping("/types/{id}/form")
public Result<DictTypeForm> getDictTypeForm(
@Parameter(description ="字典ID") @PathVariable Long id
@@ -114,7 +114,7 @@ public class SysDictController {
return Result.success(dictTypeForm);
}
@Operation(summary = "新增字典类型", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "新增字典类型")
@PostMapping("/types")
@PreAuthorize("@ss.hasPerm('sys:dict_type:add')")
@PreventDuplicateSubmit
@@ -123,7 +123,7 @@ public class SysDictController {
return Result.judge(result);
}
@Operation(summary = "修改字典类型", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "修改字典类型")
@PutMapping("/types/{id}")
@PreAuthorize("@ss.hasPerm('sys:dict_type:edit')")
public Result updateDictType(@PathVariable Long id, @RequestBody DictTypeForm dictTypeForm) {
@@ -131,7 +131,7 @@ public class SysDictController {
return Result.judge(status);
}
@Operation(summary = "删除字典类型", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "删除字典类型")
@DeleteMapping("/types/{ids}")
@PreAuthorize("@ss.hasPerm('sys:dict_type:delete')")
public Result deleteDictTypes(

22
src/main/java/com/youlai/system/controller/SysUserController.java
View File

@@ -53,7 +53,7 @@ public class SysUserController {
private final SysUserService userService;
@Operation(summary = "用户分页列表", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "用户分页列表")
@GetMapping("/page")
public PageResult<UserPageVO> getUserPage(
@ParameterObject UserPageQuery queryParams
@@ -62,7 +62,7 @@ public class SysUserController {
return PageResult.success(result);
}
@Operation(summary = "新增用户", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "新增用户")
@PostMapping
@PreAuthorize("@ss.hasPerm('sys:user:add')")
@PreventDuplicateSubmit
@@ -73,7 +73,7 @@ public class SysUserController {
return Result.judge(result);
}
@Operation(summary = "用户表单数据", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "用户表单数据")
@GetMapping("/{userId}/form")
public Result<UserForm> getUserForm(
@Parameter(description = "用户ID") @PathVariable Long userId
@@ -82,7 +82,7 @@ public class SysUserController {
return Result.success(formData);
}
@Operation(summary = "修改用户", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "修改用户")
@PutMapping(value = "/{userId}")
@PreAuthorize("@ss.hasPerm('sys:user:edit')")
public Result updateUser(
@@ -92,7 +92,7 @@ public class SysUserController {
return Result.judge(result);
}
@Operation(summary = "删除用户", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "删除用户")
@DeleteMapping("/{ids}")
@PreAuthorize("@ss.hasPerm('sys:user:delete')")
public Result deleteUsers(
@@ -102,7 +102,7 @@ public class SysUserController {
return Result.judge(result);
}
@Operation(summary = "修改用户密码", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "修改用户密码")
@PatchMapping(value = "/{userId}/password")
@PreAuthorize("@ss.hasPerm('sys:user:reset_pwd')")
public Result updatePassword(
@@ -113,7 +113,7 @@ public class SysUserController {
return Result.judge(result);
}
@Operation(summary = "修改用户状态", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "修改用户状态")
@PatchMapping(value = "/{userId}/status")
public Result updateUserStatus(
@Parameter(description = "用户ID") @PathVariable Long userId,
@@ -126,14 +126,14 @@ public class SysUserController {
return Result.judge(result);
}
@Operation(summary = "获取当前登录用户信息", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "获取当前登录用户信息")
@GetMapping("/me")
public Result<UserInfoVO> getCurrentUserInfo() {
UserInfoVO userInfoVO = userService.getCurrentUserInfo();
return Result.success(userInfoVO);
}
@Operation(summary = "用户导入模板下载", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "用户导入模板下载")
@GetMapping("/template")
public void downloadTemplate(HttpServletResponse response) throws IOException {
String fileName = "用户导入模板.xlsx";
@@ -149,7 +149,7 @@ public class SysUserController {
excelWriter.finish();
}
@Operation(summary = "导入用户", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "导入用户")
@PostMapping("/_import")
public Result importUsers(@Parameter(description = "部门ID") Long deptId, MultipartFile file) throws IOException {
UserImportListener listener = new UserImportListener(deptId);
@@ -157,7 +157,7 @@ public class SysUserController {
return Result.success(msg);
}
@Operation(summary = "导出用户", security = {@SecurityRequirement(name = "Authorization")})
@Operation(summary = "导出用户")
@GetMapping("/_export")
public void exportUsers(UserPageQuery queryParams, HttpServletResponse response) throws IOException {
String fileName = "用户列表.xlsx";