add 整合 springdoc-openapi-javadoc 基于代码注释生成文档

This commit is contained in:
疯狂的狮子li
2022-07-07 19:07:59 +08:00
parent 0b07780619
commit d9e54388e7
79 changed files with 26 additions and 548 deletions

View File

@ -19,7 +19,6 @@ import com.ruoyi.sms.config.properties.SmsProperties;
import com.ruoyi.sms.core.SmsTemplate;
import com.ruoyi.sms.entity.SmsResult;
import com.ruoyi.system.service.ISysConfigService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -53,7 +52,6 @@ public class CaptchaController {
/**
* 短信验证码
*/
@Operation(summary = "短信验证码")
@GetMapping("/captchaSms")
public R<Void> smsCaptcha(@Parameter(name = "用户手机号")
@NotBlank(message = "{user.phonenumber.not.blank}")
@ -80,7 +78,6 @@ public class CaptchaController {
/**
* 生成验证码
*/
@Operation(summary = "生成验证码")
@GetMapping("/captchaImage")
public R<Map<String, Object>> getCode() {
Map<String, Object> ajax = new HashMap<>();

View File

@ -5,7 +5,6 @@ import com.ruoyi.common.constant.CacheConstants;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.system.domain.SysCache;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.data.redis.connection.RedisServerCommands;
@ -41,7 +40,6 @@ public class CacheController {
CACHES.add(new SysCache(CacheConstants.RATE_LIMIT_KEY, "限流处理"));
}
@Operation(summary = "获取缓存监控详细信息")
@SaCheckPermission("monitor:cache:list")
@GetMapping()
public R<Map<String, Object>> getInfo() throws Exception {
@ -67,14 +65,12 @@ public class CacheController {
return R.ok(result);
}
@Operation(summary = "获取缓存名称列表")
@SaCheckPermission("monitor:cache:list")
@GetMapping("/getNames")
public R<List<SysCache>> cache() {
return R.ok(CACHES);
}
@Operation(summary = "获取KEYS基于缓存名")
@SaCheckPermission("monitor:cache:list")
@GetMapping("/getKeys/{cacheName}")
public R<Set<String>> getCacheKeys(@PathVariable String cacheName) {
@ -82,7 +78,6 @@ public class CacheController {
return R.ok(cacheKyes);
}
@Operation(summary = "获取值基于缓存名与KEY")
@SaCheckPermission("monitor:cache:list")
@GetMapping("/getValue/{cacheName}/{cacheKey}")
public R<SysCache> getCacheValue(@PathVariable String cacheName, @PathVariable String cacheKey) {
@ -91,7 +86,6 @@ public class CacheController {
return R.ok(sysCache);
}
@Operation(summary = "清空缓存名")
@SaCheckPermission("monitor:cache:list")
@DeleteMapping("/clearCacheName/{cacheName}")
public R<Void> clearCacheName(@PathVariable String cacheName) {
@ -100,7 +94,6 @@ public class CacheController {
return R.ok();
}
@Operation(summary = "清空缓存KEY")
@SaCheckPermission("monitor:cache:list")
@DeleteMapping("/clearCacheKey/{cacheKey}")
public R<Void> clearCacheKey(@PathVariable String cacheKey) {
@ -108,7 +101,6 @@ public class CacheController {
return R.ok();
}
@Operation(summary = "清空所有缓存")
@SaCheckPermission("monitor:cache:list")
@DeleteMapping("/clearCacheAll")
public R<Void> clearCacheAll() {

View File

@ -10,7 +10,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysLogininfor;
import com.ruoyi.system.service.ISysLogininforService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@ -33,14 +32,12 @@ public class SysLogininforController extends BaseController {
private final ISysLogininforService logininforService;
@Operation(summary = "查询系统访问记录列表")
@SaCheckPermission("monitor:logininfor:list")
@GetMapping("/list")
public TableDataInfo<SysLogininfor> list(SysLogininfor logininfor, PageQuery pageQuery) {
return logininforService.selectPageLogininforList(logininfor, pageQuery);
}
@Operation(summary = "导出系统访问记录列表")
@Log(title = "登录日志", businessType = BusinessType.EXPORT)
@SaCheckPermission("monitor:logininfor:export")
@PostMapping("/export")
@ -49,7 +46,6 @@ public class SysLogininforController extends BaseController {
ExcelUtil.exportExcel(list, "登录日志", SysLogininfor.class, response);
}
@Operation(summary = "删除系统访问记录")
@SaCheckPermission("monitor:logininfor:remove")
@Log(title = "登录日志", businessType = BusinessType.DELETE)
@DeleteMapping("/{infoIds}")
@ -57,7 +53,6 @@ public class SysLogininforController extends BaseController {
return toAjax(logininforService.deleteLogininforByIds(infoIds));
}
@Operation(summary = "清空系统访问记录")
@SaCheckPermission("monitor:logininfor:remove")
@Log(title = "登录日志", businessType = BusinessType.CLEAN)
@DeleteMapping("/clean")

View File

@ -10,7 +10,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysOperLog;
import com.ruoyi.system.service.ISysOperLogService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@ -33,14 +32,12 @@ public class SysOperlogController extends BaseController {
private final ISysOperLogService operLogService;
@Operation(summary = "查询操作日志记录列表")
@SaCheckPermission("monitor:operlog:list")
@GetMapping("/list")
public TableDataInfo<SysOperLog> list(SysOperLog operLog, PageQuery pageQuery) {
return operLogService.selectPageOperLogList(operLog, pageQuery);
}
@Operation(summary = "导出操作日志记录列表")
@Log(title = "操作日志", businessType = BusinessType.EXPORT)
@SaCheckPermission("monitor:operlog:export")
@PostMapping("/export")
@ -49,7 +46,6 @@ public class SysOperlogController extends BaseController {
ExcelUtil.exportExcel(list, "操作日志", SysOperLog.class, response);
}
@Operation(summary = "删除操作日志记录")
@Log(title = "操作日志", businessType = BusinessType.DELETE)
@SaCheckPermission("monitor:operlog:remove")
@DeleteMapping("/{operIds}")
@ -57,7 +53,6 @@ public class SysOperlogController extends BaseController {
return toAjax(operLogService.deleteOperLogByIds(operIds));
}
@Operation(summary = "清空操作日志记录")
@Log(title = "操作日志", businessType = BusinessType.CLEAN)
@SaCheckPermission("monitor:operlog:remove")
@DeleteMapping("/clean")

View File

@ -15,7 +15,6 @@ import com.ruoyi.common.utils.StreamUtils;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.redis.RedisUtils;
import com.ruoyi.system.domain.SysUserOnline;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
@ -35,7 +34,6 @@ import java.util.List;
@RequestMapping("/monitor/online")
public class SysUserOnlineController extends BaseController {
@Operation(summary = "在线用户列表")
@SaCheckPermission("monitor:online:list")
@GetMapping("/list")
public TableDataInfo<SysUserOnline> list(String ipaddr, String userName) {
@ -73,7 +71,6 @@ public class SysUserOnlineController extends BaseController {
/**
* 强退用户
*/
@Operation(summary = "强退用户")
@SaCheckPermission("monitor:online:forceLogout")
@Log(title = "在线用户", businessType = BusinessType.FORCE)
@DeleteMapping("/{tokenId}")

View File

@ -11,7 +11,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysConfig;
import com.ruoyi.system.service.ISysConfigService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -38,14 +37,12 @@ public class SysConfigController extends BaseController {
/**
* 获取参数配置列表
*/
@Operation(summary = "获取参数配置列表")
@SaCheckPermission("system:config:list")
@GetMapping("/list")
public TableDataInfo<SysConfig> list(SysConfig config, PageQuery pageQuery) {
return configService.selectPageConfigList(config, pageQuery);
}
@Operation(summary = "导出参数配置列表")
@Log(title = "参数管理", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:config:export")
@PostMapping("/export")
@ -57,7 +54,6 @@ public class SysConfigController extends BaseController {
/**
* 根据参数编号获取详细信息
*/
@Operation(summary = "根据参数编号获取详细信息")
@SaCheckPermission("system:config:query")
@GetMapping(value = "/{configId}")
public R<SysConfig> getInfo(@Parameter(name = "参数ID") @PathVariable Long configId) {
@ -67,7 +63,6 @@ public class SysConfigController extends BaseController {
/**
* 根据参数键名查询参数值
*/
@Operation(summary = "根据参数键名查询参数值")
@GetMapping(value = "/configKey/{configKey}")
public R<Void> getConfigKey(@Parameter(name = "参数Key") @PathVariable String configKey) {
return R.ok(configService.selectConfigByKey(configKey));
@ -76,7 +71,6 @@ public class SysConfigController extends BaseController {
/**
* 新增参数配置
*/
@Operation(summary = "新增参数配置")
@SaCheckPermission("system:config:add")
@Log(title = "参数管理", businessType = BusinessType.INSERT)
@PostMapping
@ -90,7 +84,6 @@ public class SysConfigController extends BaseController {
/**
* 修改参数配置
*/
@Operation(summary = "修改参数配置")
@SaCheckPermission("system:config:edit")
@Log(title = "参数管理", businessType = BusinessType.UPDATE)
@PutMapping
@ -104,7 +97,6 @@ public class SysConfigController extends BaseController {
/**
* 根据参数键名修改参数配置
*/
@Operation(summary = "根据参数键名修改参数配置")
@SaCheckPermission("system:config:edit")
@Log(title = "参数管理", businessType = BusinessType.UPDATE)
@PutMapping("/updateByKey")
@ -115,7 +107,6 @@ public class SysConfigController extends BaseController {
/**
* 删除参数配置
*/
@Operation(summary = "删除参数配置")
@SaCheckPermission("system:config:remove")
@Log(title = "参数管理", businessType = BusinessType.DELETE)
@DeleteMapping("/{configIds}")
@ -127,7 +118,6 @@ public class SysConfigController extends BaseController {
/**
* 刷新参数缓存
*/
@Operation(summary = "刷新参数缓存")
@SaCheckPermission("system:config:remove")
@Log(title = "参数管理", businessType = BusinessType.CLEAN)
@DeleteMapping("/refreshCache")

View File

@ -11,7 +11,6 @@ import com.ruoyi.common.core.domain.entity.SysDept;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.system.service.ISysDeptService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -39,7 +38,6 @@ public class SysDeptController extends BaseController {
/**
* 获取部门列表
*/
@Operation(summary = "获取部门列表")
@SaCheckPermission("system:dept:list")
@GetMapping("/list")
public R<List<SysDept>> list(SysDept dept) {
@ -50,7 +48,6 @@ public class SysDeptController extends BaseController {
/**
* 查询部门列表(排除节点)
*/
@Operation(summary = "查询部门列表(排除节点)")
@SaCheckPermission("system:dept:list")
@GetMapping("/list/exclude/{deptId}")
public R<List<SysDept>> excludeChild(@Parameter(name = "部门ID") @PathVariable(value = "deptId", required = false) Long deptId) {
@ -63,7 +60,6 @@ public class SysDeptController extends BaseController {
/**
* 根据部门编号获取详细信息
*/
@Operation(summary = "根据部门编号获取详细信息")
@SaCheckPermission("system:dept:query")
@GetMapping(value = "/{deptId}")
public R<SysDept> getInfo(@Parameter(name = "部门ID") @PathVariable Long deptId) {
@ -74,7 +70,6 @@ public class SysDeptController extends BaseController {
/**
* 获取部门下拉树列表
*/
@Operation(summary = "获取部门下拉树列表")
@GetMapping("/treeselect")
public R<List<Tree<Long>>> treeselect(SysDept dept) {
List<SysDept> depts = deptService.selectDeptList(dept);
@ -84,7 +79,6 @@ public class SysDeptController extends BaseController {
/**
* 加载对应角色部门列表树
*/
@Operation(summary = "加载对应角色部门列表树")
@GetMapping(value = "/roleDeptTreeselect/{roleId}")
public R<Map<String, Object>> roleDeptTreeselect(@Parameter(name = "角色ID") @PathVariable("roleId") Long roleId) {
List<SysDept> depts = deptService.selectDeptList(new SysDept());
@ -97,7 +91,6 @@ public class SysDeptController extends BaseController {
/**
* 新增部门
*/
@Operation(summary = "新增部门")
@SaCheckPermission("system:dept:add")
@Log(title = "部门管理", businessType = BusinessType.INSERT)
@PostMapping
@ -111,7 +104,6 @@ public class SysDeptController extends BaseController {
/**
* 修改部门
*/
@Operation(summary = "修改部门")
@SaCheckPermission("system:dept:edit")
@Log(title = "部门管理", businessType = BusinessType.UPDATE)
@PutMapping
@ -132,7 +124,6 @@ public class SysDeptController extends BaseController {
/**
* 删除部门
*/
@Operation(summary = "删除部门")
@SaCheckPermission("system:dept:remove")
@Log(title = "部门管理", businessType = BusinessType.DELETE)
@DeleteMapping("/{deptId}")

View File

@ -12,7 +12,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.service.ISysDictDataService;
import com.ruoyi.system.service.ISysDictTypeService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -38,14 +37,12 @@ public class SysDictDataController extends BaseController {
private final ISysDictDataService dictDataService;
private final ISysDictTypeService dictTypeService;
@Operation(summary = "查询字典数据列表")
@SaCheckPermission("system:dict:list")
@GetMapping("/list")
public TableDataInfo<SysDictData> list(SysDictData dictData, PageQuery pageQuery) {
return dictDataService.selectPageDictDataList(dictData, pageQuery);
}
@Operation(summary = "导出字典数据列表")
@Log(title = "字典数据", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:dict:export")
@PostMapping("/export")
@ -57,7 +54,6 @@ public class SysDictDataController extends BaseController {
/**
* 查询字典数据详细
*/
@Operation(summary = "查询字典数据详细")
@SaCheckPermission("system:dict:query")
@GetMapping(value = "/{dictCode}")
public R<SysDictData> getInfo(@Parameter(name = "字典code") @PathVariable Long dictCode) {
@ -67,7 +63,6 @@ public class SysDictDataController extends BaseController {
/**
* 根据字典类型查询字典数据信息
*/
@Operation(summary = "根据字典类型查询字典数据信息")
@GetMapping(value = "/type/{dictType}")
public R<List<SysDictData>> dictType(@Parameter(name = "字典类型") @PathVariable String dictType) {
List<SysDictData> data = dictTypeService.selectDictDataByType(dictType);
@ -80,7 +75,6 @@ public class SysDictDataController extends BaseController {
/**
* 新增字典类型
*/
@Operation(summary = "新增字典类型")
@SaCheckPermission("system:dict:add")
@Log(title = "字典数据", businessType = BusinessType.INSERT)
@PostMapping
@ -91,7 +85,6 @@ public class SysDictDataController extends BaseController {
/**
* 修改保存字典类型
*/
@Operation(summary = "修改保存字典类型")
@SaCheckPermission("system:dict:edit")
@Log(title = "字典数据", businessType = BusinessType.UPDATE)
@PutMapping
@ -102,7 +95,6 @@ public class SysDictDataController extends BaseController {
/**
* 删除字典类型
*/
@Operation(summary = "删除字典类型")
@SaCheckPermission("system:dict:remove")
@Log(title = "字典类型", businessType = BusinessType.DELETE)
@DeleteMapping("/{dictCodes}")

View File

@ -11,7 +11,6 @@ import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.service.ISysDictTypeService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -35,14 +34,12 @@ public class SysDictTypeController extends BaseController {
private final ISysDictTypeService dictTypeService;
@Operation(summary = "查询字典类型列表")
@SaCheckPermission("system:dict:list")
@GetMapping("/list")
public TableDataInfo<SysDictType> list(SysDictType dictType, PageQuery pageQuery) {
return dictTypeService.selectPageDictTypeList(dictType, pageQuery);
}
@Operation(summary = "导出字典类型列表")
@Log(title = "字典类型", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:dict:export")
@PostMapping("/export")
@ -54,7 +51,6 @@ public class SysDictTypeController extends BaseController {
/**
* 查询字典类型详细
*/
@Operation(summary = "查询字典类型详细")
@SaCheckPermission("system:dict:query")
@GetMapping(value = "/{dictId}")
public R<SysDictType> getInfo(@Parameter(name = "字典ID") @PathVariable Long dictId) {
@ -64,7 +60,6 @@ public class SysDictTypeController extends BaseController {
/**
* 新增字典类型
*/
@Operation(summary = "新增字典类型")
@SaCheckPermission("system:dict:add")
@Log(title = "字典类型", businessType = BusinessType.INSERT)
@PostMapping
@ -78,7 +73,6 @@ public class SysDictTypeController extends BaseController {
/**
* 修改字典类型
*/
@Operation(summary = "修改字典类型")
@SaCheckPermission("system:dict:edit")
@Log(title = "字典类型", businessType = BusinessType.UPDATE)
@PutMapping
@ -92,7 +86,6 @@ public class SysDictTypeController extends BaseController {
/**
* 删除字典类型
*/
@Operation(summary = "删除字典类型")
@SaCheckPermission("system:dict:remove")
@Log(title = "字典类型", businessType = BusinessType.DELETE)
@DeleteMapping("/{dictIds}")
@ -104,7 +97,6 @@ public class SysDictTypeController extends BaseController {
/**
* 刷新字典缓存
*/
@Operation(summary = "刷新字典缓存")
@SaCheckPermission("system:dict:remove")
@Log(title = "字典类型", businessType = BusinessType.CLEAN)
@DeleteMapping("/refreshCache")
@ -116,7 +108,6 @@ public class SysDictTypeController extends BaseController {
/**
* 获取字典选择框列表
*/
@Operation(summary = "获取字典选择框列表")
@GetMapping("/optionselect")
public R<List<SysDictType>> optionselect() {
List<SysDictType> dictTypes = dictTypeService.selectDictTypeAll();

View File

@ -2,7 +2,6 @@ package com.ruoyi.web.controller.system;
import com.ruoyi.common.config.RuoYiConfig;
import com.ruoyi.common.utils.StringUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
@ -26,7 +25,6 @@ public class SysIndexController {
/**
* 访问首页,提示语
*/
@Operation(summary = "访问首页,提示语")
@GetMapping("/")
public String index() {
return StringUtils.format("欢迎使用{}后台管理框架当前版本v{},请通过前端地址访问。", ruoyiConfig.getName(), ruoyiConfig.getVersion());

View File

@ -13,7 +13,6 @@ import com.ruoyi.system.service.ISysMenuService;
import com.ruoyi.system.service.ISysUserService;
import com.ruoyi.system.service.SysLoginService;
import com.ruoyi.system.service.SysPermissionService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@ -51,7 +50,6 @@ public class SysLoginController {
* @return 结果
*/
@Anonymous
@Operation(summary = "登录方法")
@PostMapping("/login")
public R<Map<String, Object>> login(@Validated @RequestBody LoginBody loginBody) {
Map<String, Object> ajax = new HashMap<>();
@ -69,7 +67,6 @@ public class SysLoginController {
* @return 结果
*/
@Anonymous
@Operation(summary = "短信登录(示例)")
@PostMapping("/smsLogin")
public R<Map<String, Object>> smsLogin(@Validated @RequestBody SmsLoginBody smsLoginBody) {
Map<String, Object> ajax = new HashMap<>();
@ -86,7 +83,6 @@ public class SysLoginController {
* @return 结果
*/
@Anonymous
@Operation(summary = "小程序登录(示例)")
@PostMapping("/xcxLogin")
public R<Map<String, Object>> xcxLogin(@NotBlank(message = "{xcx.code.not.blank}") String xcxCode) {
Map<String, Object> ajax = new HashMap<>();
@ -97,7 +93,6 @@ public class SysLoginController {
}
@Anonymous
@Operation(summary = "登出方法")
@PostMapping("/logout")
public R<Void> logout() {
loginService.logout();
@ -109,7 +104,6 @@ public class SysLoginController {
*
* @return 用户信息
*/
@Operation(summary = "获取用户信息")
@GetMapping("getInfo")
public R<Map<String, Object>> getInfo() {
SysUser user = userService.selectUserById(LoginHelper.getUserId());
@ -129,7 +123,6 @@ public class SysLoginController {
*
* @return 路由信息
*/
@Operation(summary = "获取路由信息")
@GetMapping("getRouters")
public R<List<RouterVo>> getRouters() {
Long userId = LoginHelper.getUserId();

View File

@ -10,7 +10,6 @@ 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.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -38,7 +37,6 @@ public class SysMenuController extends BaseController {
/**
* 获取菜单列表
*/
@Operation(summary = "获取菜单列表")
@SaCheckPermission("system:menu:list")
@GetMapping("/list")
public R<List<SysMenu>> list(SysMenu menu) {
@ -49,7 +47,6 @@ public class SysMenuController extends BaseController {
/**
* 根据菜单编号获取详细信息
*/
@Operation(summary = "根据菜单编号获取详细信息")
@SaCheckPermission("system:menu:query")
@GetMapping(value = "/{menuId}")
public R<SysMenu> getInfo(@Parameter(name = "菜单ID") @PathVariable Long menuId) {
@ -59,7 +56,6 @@ public class SysMenuController extends BaseController {
/**
* 获取菜单下拉树列表
*/
@Operation(summary = "获取菜单下拉树列表")
@GetMapping("/treeselect")
public R<List<Tree<Long>>> treeselect(SysMenu menu) {
List<SysMenu> menus = menuService.selectMenuList(menu, getUserId());
@ -69,7 +65,6 @@ public class SysMenuController extends BaseController {
/**
* 加载对应角色菜单列表树
*/
@Operation(summary = "加载对应角色菜单列表树")
@GetMapping(value = "/roleMenuTreeselect/{roleId}")
public R<Map<String, Object>> roleMenuTreeselect(@Parameter(name = "角色ID") @PathVariable("roleId") Long roleId) {
List<SysMenu> menus = menuService.selectMenuList(getUserId());
@ -82,7 +77,6 @@ public class SysMenuController extends BaseController {
/**
* 新增菜单
*/
@Operation(summary = "新增菜单")
@SaCheckPermission("system:menu:add")
@Log(title = "菜单管理", businessType = BusinessType.INSERT)
@PostMapping
@ -98,7 +92,6 @@ public class SysMenuController extends BaseController {
/**
* 修改菜单
*/
@Operation(summary = "修改菜单")
@SaCheckPermission("system:menu:edit")
@Log(title = "菜单管理", businessType = BusinessType.UPDATE)
@PutMapping
@ -116,7 +109,6 @@ public class SysMenuController extends BaseController {
/**
* 删除菜单
*/
@Operation(summary = "删除菜单")
@SaCheckPermission("system:menu:remove")
@Log(title = "菜单管理", businessType = BusinessType.DELETE)
@DeleteMapping("/{menuId}")

View File

@ -9,7 +9,6 @@ import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.system.domain.SysNotice;
import com.ruoyi.system.service.ISysNoticeService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -33,7 +32,6 @@ public class SysNoticeController extends BaseController {
/**
* 获取通知公告列表
*/
@Operation(summary = "获取通知公告列表")
@SaCheckPermission("system:notice:list")
@GetMapping("/list")
public TableDataInfo<SysNotice> list(SysNotice notice, PageQuery pageQuery) {
@ -43,7 +41,6 @@ public class SysNoticeController extends BaseController {
/**
* 根据通知公告编号获取详细信息
*/
@Operation(summary = "根据通知公告编号获取详细信息")
@SaCheckPermission("system:notice:query")
@GetMapping(value = "/{noticeId}")
public R<SysNotice> getInfo(@Parameter(name = "公告ID") @PathVariable Long noticeId) {
@ -53,7 +50,6 @@ public class SysNoticeController extends BaseController {
/**
* 新增通知公告
*/
@Operation(summary = "新增通知公告")
@SaCheckPermission("system:notice:add")
@Log(title = "通知公告", businessType = BusinessType.INSERT)
@PostMapping
@ -64,7 +60,6 @@ public class SysNoticeController extends BaseController {
/**
* 修改通知公告
*/
@Operation(summary = "修改通知公告")
@SaCheckPermission("system:notice:edit")
@Log(title = "通知公告", businessType = BusinessType.UPDATE)
@PutMapping
@ -75,7 +70,6 @@ public class SysNoticeController extends BaseController {
/**
* 删除通知公告
*/
@Operation(summary = "删除通知公告")
@SaCheckPermission("system:notice:remove")
@Log(title = "通知公告", businessType = BusinessType.DELETE)
@DeleteMapping("/{noticeIds}")

View File

@ -14,7 +14,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.system.domain.bo.SysOssConfigBo;
import com.ruoyi.system.domain.vo.SysOssConfigVo;
import com.ruoyi.system.service.ISysOssConfigService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -44,7 +43,6 @@ public class SysOssConfigController extends BaseController {
/**
* 查询对象存储配置列表
*/
@Operation(summary = "查询对象存储配置列表")
@SaCheckPermission("system:oss:list")
@GetMapping("/list")
public TableDataInfo<SysOssConfigVo> list(@Validated(QueryGroup.class) SysOssConfigBo bo, PageQuery pageQuery) {
@ -54,7 +52,6 @@ public class SysOssConfigController extends BaseController {
/**
* 获取对象存储配置详细信息
*/
@Operation(summary = "获取对象存储配置详细信息")
@SaCheckPermission("system:oss:query")
@GetMapping("/{ossConfigId}")
public R<SysOssConfigVo> getInfo(@Parameter(name = "OSS配置ID")
@ -66,7 +63,6 @@ public class SysOssConfigController extends BaseController {
/**
* 新增对象存储配置
*/
@Operation(summary = "新增对象存储配置")
@SaCheckPermission("system:oss:add")
@Log(title = "对象存储配置", businessType = BusinessType.INSERT)
@RepeatSubmit()
@ -78,7 +74,6 @@ public class SysOssConfigController extends BaseController {
/**
* 修改对象存储配置
*/
@Operation(summary = "修改对象存储配置")
@SaCheckPermission("system:oss:edit")
@Log(title = "对象存储配置", businessType = BusinessType.UPDATE)
@RepeatSubmit()
@ -90,7 +85,6 @@ public class SysOssConfigController extends BaseController {
/**
* 删除对象存储配置
*/
@Operation(summary = "删除对象存储配置")
@SaCheckPermission("system:oss:remove")
@Log(title = "对象存储配置", businessType = BusinessType.DELETE)
@DeleteMapping("/{ossConfigIds}")
@ -103,7 +97,6 @@ public class SysOssConfigController extends BaseController {
/**
* 状态修改
*/
@Operation(summary = "状态修改")
@SaCheckPermission("system:oss:edit")
@Log(title = "对象存储状态修改", businessType = BusinessType.UPDATE)
@PutMapping("/changeStatus")

View File

@ -19,7 +19,6 @@ import com.ruoyi.system.domain.SysOss;
import com.ruoyi.system.domain.bo.SysOssBo;
import com.ruoyi.system.domain.vo.SysOssVo;
import com.ruoyi.system.service.ISysOssService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
@ -55,7 +54,6 @@ public class SysOssController extends BaseController {
/**
* 查询OSS对象存储列表
*/
@Operation(summary = "查询OSS对象存储列表")
@SaCheckPermission("system:oss:list")
@GetMapping("/list")
public TableDataInfo<SysOssVo> list(@Validated(QueryGroup.class) SysOssBo bo, PageQuery pageQuery) {
@ -65,7 +63,6 @@ public class SysOssController extends BaseController {
/**
* 查询OSS对象基于id串
*/
@Operation(summary = "查询OSS对象基于ID")
@SaCheckPermission("system:oss:list")
@GetMapping("/listByIds/{ossIds}")
public R<List<SysOssVo>> listByIds(@Parameter(name = "OSS对象ID串")
@ -78,7 +75,6 @@ public class SysOssController extends BaseController {
/**
* 上传OSS对象存储
*/
@Operation(summary = "上传OSS对象存储")
@Parameters({
@Parameter(name = "file", description = "文件", in = ParameterIn.QUERY, required = true)
})
@ -97,7 +93,6 @@ public class SysOssController extends BaseController {
return R.ok(map);
}
@Operation(summary = "下载OSS对象存储")
@SaCheckPermission("system:oss:download")
@GetMapping("/download/{ossId}")
public void download(@Parameter(name = "OSS对象ID") @PathVariable Long ossId, HttpServletResponse response) throws IOException {
@ -124,7 +119,6 @@ public class SysOssController extends BaseController {
/**
* 删除OSS对象存储
*/
@Operation(summary = "删除OSS对象存储")
@SaCheckPermission("system:oss:remove")
@Log(title = "OSS对象存储", businessType = BusinessType.DELETE)
@DeleteMapping("/{ossIds}")

View File

@ -11,7 +11,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysPost;
import com.ruoyi.system.service.ISysPostService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
@ -38,14 +37,12 @@ public class SysPostController extends BaseController {
/**
* 获取岗位列表
*/
@Operation(summary = "获取岗位列表")
@SaCheckPermission("system:post:list")
@GetMapping("/list")
public TableDataInfo<SysPost> list(SysPost post, PageQuery pageQuery) {
return postService.selectPagePostList(post, pageQuery);
}
@Operation(summary = "导出岗位列表")
@Log(title = "岗位管理", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:post:export")
@PostMapping("/export")
@ -57,7 +54,6 @@ public class SysPostController extends BaseController {
/**
* 根据岗位编号获取详细信息
*/
@Operation(summary = "根据岗位编号获取详细信息")
@SaCheckPermission("system:post:query")
@GetMapping(value = "/{postId}")
public R<SysPost> getInfo(@Parameter(name = "岗位ID") @PathVariable Long postId) {
@ -67,7 +63,6 @@ public class SysPostController extends BaseController {
/**
* 新增岗位
*/
@Operation(summary = "新增岗位")
@SaCheckPermission("system:post:add")
@Log(title = "岗位管理", businessType = BusinessType.INSERT)
@PostMapping
@ -83,7 +78,6 @@ public class SysPostController extends BaseController {
/**
* 修改岗位
*/
@Operation(summary = "修改岗位")
@SaCheckPermission("system:post:edit")
@Log(title = "岗位管理", businessType = BusinessType.UPDATE)
@PutMapping
@ -99,7 +93,6 @@ public class SysPostController extends BaseController {
/**
* 删除岗位
*/
@Operation(summary = "删除岗位")
@SaCheckPermission("system:post:remove")
@Log(title = "岗位管理", businessType = BusinessType.DELETE)
@DeleteMapping("/{postIds}")
@ -110,7 +103,6 @@ public class SysPostController extends BaseController {
/**
* 获取岗位选择框列表
*/
@Operation(summary = "获取岗位选择框列表")
@GetMapping("/optionselect")
public R<List<SysPost>> optionselect() {
List<SysPost> posts = postService.selectPostAll();

View File

@ -14,7 +14,6 @@ import com.ruoyi.common.utils.file.MimeTypeUtils;
import com.ruoyi.system.domain.SysOss;
import com.ruoyi.system.service.ISysOssService;
import com.ruoyi.system.service.ISysUserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
@ -46,7 +45,6 @@ public class SysProfileController extends BaseController {
/**
* 个人信息
*/
@Operation(summary = "个人信息")
@GetMapping
public R<Map<String, Object>> profile() {
SysUser user = userService.selectUserById(getUserId());
@ -60,7 +58,6 @@ public class SysProfileController extends BaseController {
/**
* 修改用户
*/
@Operation(summary = "修改用户")
@Log(title = "个人信息", businessType = BusinessType.UPDATE)
@PutMapping
public R<Void> updateProfile(@RequestBody SysUser user) {
@ -84,7 +81,6 @@ public class SysProfileController extends BaseController {
/**
* 重置密码
*/
@Operation(summary = "重置密码")
@Parameters({
@Parameter(name = "oldPassword", description = "旧密码", in = ParameterIn.QUERY),
@Parameter(name = "newPassword", description = "新密码", in = ParameterIn.QUERY)
@ -111,7 +107,6 @@ public class SysProfileController extends BaseController {
/**
* 头像上传
*/
@Operation(summary = "头像上传")
@Parameters({
@Parameter(name = "avatarfile", description = "用户头像", in = ParameterIn.QUERY, required = true)
})

View File

@ -6,7 +6,6 @@ import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.domain.model.RegisterBody;
import com.ruoyi.system.service.ISysConfigService;
import com.ruoyi.system.service.SysRegisterService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
@ -29,7 +28,6 @@ public class SysRegisterController extends BaseController {
private final ISysConfigService configService;
@Anonymous
@Operation(summary = "用户注册")
@PostMapping("/register")
public R<Void> register(@Validated @RequestBody RegisterBody user) {
if (!("true".equals(configService.selectConfigByKey("sys.account.registerUser")))) {

View File

@ -18,7 +18,6 @@ import com.ruoyi.system.domain.SysUserRole;
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
import com.ruoyi.system.service.SysPermissionService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
@ -46,14 +45,12 @@ public class SysRoleController extends BaseController {
private final ISysUserService userService;
private final SysPermissionService permissionService;
@Operation(summary = "查询角色信息列表")
@SaCheckPermission("system:role:list")
@GetMapping("/list")
public TableDataInfo<SysRole> list(SysRole role, PageQuery pageQuery) {
return roleService.selectPageRoleList(role, pageQuery);
}
@Operation(summary = "导出角色信息列表")
@Log(title = "角色管理", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:role:export")
@PostMapping("/export")
@ -65,7 +62,6 @@ public class SysRoleController extends BaseController {
/**
* 根据角色编号获取详细信息
*/
@Operation(summary = "根据角色编号获取详细信息")
@SaCheckPermission("system:role:query")
@GetMapping(value = "/{roleId}")
public R<SysRole> getInfo(@Parameter(name = "角色ID") @PathVariable Long roleId) {
@ -76,7 +72,6 @@ public class SysRoleController extends BaseController {
/**
* 新增角色
*/
@Operation(summary = "新增角色")
@SaCheckPermission("system:role:add")
@Log(title = "角色管理", businessType = BusinessType.INSERT)
@PostMapping
@ -93,7 +88,6 @@ public class SysRoleController extends BaseController {
/**
* 修改保存角色
*/
@Operation(summary = "修改保存角色")
@SaCheckPermission("system:role:edit")
@Log(title = "角色管理", businessType = BusinessType.UPDATE)
@PutMapping
@ -122,7 +116,6 @@ public class SysRoleController extends BaseController {
/**
* 修改保存数据权限
*/
@Operation(summary = "修改保存数据权限")
@SaCheckPermission("system:role:edit")
@Log(title = "角色管理", businessType = BusinessType.UPDATE)
@PutMapping("/dataScope")
@ -135,7 +128,6 @@ public class SysRoleController extends BaseController {
/**
* 状态修改
*/
@Operation(summary = "状态修改")
@SaCheckPermission("system:role:edit")
@Log(title = "角色管理", businessType = BusinessType.UPDATE)
@PutMapping("/changeStatus")
@ -148,7 +140,6 @@ public class SysRoleController extends BaseController {
/**
* 删除角色
*/
@Operation(summary = "删除角色")
@SaCheckPermission("system:role:remove")
@Log(title = "角色管理", businessType = BusinessType.DELETE)
@DeleteMapping("/{roleIds}")
@ -159,7 +150,6 @@ public class SysRoleController extends BaseController {
/**
* 获取角色选择框列表
*/
@Operation(summary = "获取角色选择框列表")
@SaCheckPermission("system:role:query")
@GetMapping("/optionselect")
public R<List<SysRole>> optionselect() {
@ -169,7 +159,6 @@ public class SysRoleController extends BaseController {
/**
* 查询已分配用户角色列表
*/
@Operation(summary = "查询已分配用户角色列表")
@SaCheckPermission("system:role:list")
@GetMapping("/authUser/allocatedList")
public TableDataInfo<SysUser> allocatedList(SysUser user, PageQuery pageQuery) {
@ -179,7 +168,6 @@ public class SysRoleController extends BaseController {
/**
* 查询未分配用户角色列表
*/
@Operation(summary = "查询未分配用户角色列表")
@SaCheckPermission("system:role:list")
@GetMapping("/authUser/unallocatedList")
public TableDataInfo<SysUser> unallocatedList(SysUser user, PageQuery pageQuery) {
@ -189,7 +177,6 @@ public class SysRoleController extends BaseController {
/**
* 取消授权用户
*/
@Operation(summary = "取消授权用户")
@SaCheckPermission("system:role:edit")
@Log(title = "角色管理", businessType = BusinessType.GRANT)
@PutMapping("/authUser/cancel")
@ -200,7 +187,6 @@ public class SysRoleController extends BaseController {
/**
* 批量取消授权用户
*/
@Operation(summary = "批量取消授权用户")
@Parameters({
@Parameter(name = "roleId", description = "角色ID", in = ParameterIn.QUERY),
@Parameter(name = "userIds", description = "用户ID串", in = ParameterIn.QUERY)
@ -215,7 +201,6 @@ public class SysRoleController extends BaseController {
/**
* 批量选择用户授权
*/
@Operation(summary = "批量选择用户授权")
@Parameters({
@Parameter(name = "roleId", description = "角色ID", in = ParameterIn.QUERY),
@Parameter(name = "userIds", description = "用户ID串", in = ParameterIn.QUERY)

View File

@ -26,7 +26,6 @@ import com.ruoyi.system.listener.SysUserImportListener;
import com.ruoyi.system.service.ISysPostService;
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
@ -61,14 +60,12 @@ public class SysUserController extends BaseController {
/**
* 获取用户列表
*/
@Operation(summary = "获取用户列表")
@SaCheckPermission("system:user:list")
@GetMapping("/list")
public TableDataInfo<SysUser> list(SysUser user, PageQuery pageQuery) {
return userService.selectPageUserList(user, pageQuery);
}
@Operation(summary = "导出用户列表")
@Log(title = "用户管理", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:user:export")
@PostMapping("/export")
@ -86,7 +83,6 @@ public class SysUserController extends BaseController {
ExcelUtil.exportExcel(listVo, "用户数据", SysUserExportVo.class, response);
}
@Operation(summary = "导入用户列表")
@Parameters({
@Parameter(name = "file", description = "导入文件", required = true),
})
@ -98,7 +94,6 @@ public class SysUserController extends BaseController {
return R.ok(result.getAnalysis());
}
@Operation(summary = "下载导入模板")
@PostMapping("/importTemplate")
public void importTemplate(HttpServletResponse response) {
ExcelUtil.exportExcel(new ArrayList<>(), "用户数据", SysUserImportVo.class, response);
@ -107,7 +102,6 @@ public class SysUserController extends BaseController {
/**
* 根据用户编号获取详细信息
*/
@Operation(summary = "根据用户编号获取详细信息")
@SaCheckPermission("system:user:query")
@GetMapping(value = {"/", "/{userId}"})
public R<Map<String, Object>> getInfo(@Parameter(name = "用户ID") @PathVariable(value = "userId", required = false) Long userId) {
@ -128,7 +122,6 @@ public class SysUserController extends BaseController {
/**
* 新增用户
*/
@Operation(summary = "新增用户")
@SaCheckPermission("system:user:add")
@Log(title = "用户管理", businessType = BusinessType.INSERT)
@PostMapping
@ -149,7 +142,6 @@ public class SysUserController extends BaseController {
/**
* 修改用户
*/
@Operation(summary = "修改用户")
@SaCheckPermission("system:user:edit")
@Log(title = "用户管理", businessType = BusinessType.UPDATE)
@PutMapping
@ -169,7 +161,6 @@ public class SysUserController extends BaseController {
/**
* 删除用户
*/
@Operation(summary = "删除用户")
@SaCheckPermission("system:user:remove")
@Log(title = "用户管理", businessType = BusinessType.DELETE)
@DeleteMapping("/{userIds}")
@ -183,7 +174,6 @@ public class SysUserController extends BaseController {
/**
* 重置密码
*/
@Operation(summary = "重置密码")
@SaCheckPermission("system:user:resetPwd")
@Log(title = "用户管理", businessType = BusinessType.UPDATE)
@PutMapping("/resetPwd")
@ -197,7 +187,6 @@ public class SysUserController extends BaseController {
/**
* 状态修改
*/
@Operation(summary = "状态修改")
@SaCheckPermission("system:user:edit")
@Log(title = "用户管理", businessType = BusinessType.UPDATE)
@PutMapping("/changeStatus")
@ -210,7 +199,6 @@ public class SysUserController extends BaseController {
/**
* 根据用户编号获取授权角色
*/
@Operation(summary = "根据用户编号获取授权角色")
@SaCheckPermission("system:user:query")
@GetMapping("/authRole/{userId}")
public R<Map<String, Object>> authRole(@Parameter(name = "用户ID") @PathVariable("userId") Long userId) {
@ -225,7 +213,6 @@ public class SysUserController extends BaseController {
/**
* 用户授权角色
*/
@Operation(summary = "用户授权角色")
@Parameters({
@Parameter(name = "userId", description = "用户Id", in = ParameterIn.QUERY),
@Parameter(name = "roleIds", description = "角色ID串", in = ParameterIn.QUERY)

View File

@ -215,11 +215,11 @@ springdoc:
enabled: true
#这里定义了两个分组,可定义多个,也可以不定义
group-configs:
- group: 演示模块
- group: 1.演示模块
packages-to-scan: com.ruoyi.demo
- group: 系统模块
- group: 2.系统模块
packages-to-scan: com.ruoyi.web
- group: 代码生成模块
- group: 3.代码生成模块
packages-to-scan: com.ruoyi.generator
# 防止XSS攻击