添加swagger注解

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysConfigController.java

@@ -2,6 +2,9 @@ package com.zksy.web.controller.system;
 
 import java.util.List;
 import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -29,6 +32,7 @@ import com.zksy.system.service.ISysConfigService;
  */
 @RestController
 @RequestMapping("/system/config")
+@Api(tags = "参数配置信息", description = "参数配置信息desc")
 public class SysConfigController extends BaseController
 {
     @Autowired
@@ -39,6 +43,7 @@ public class SysConfigController extends BaseController
      */
     @PreAuthorize("@ss.hasPermi('system:config:list')")
     @GetMapping("/list")
+    @ApiOperation(value = "获取参数配置列表")
     public TableDataInfo list(SysConfig config)
     {
         startPage();
@@ -49,6 +54,7 @@ public class SysConfigController extends BaseController
     @Log(title = "参数管理", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:config:export')")
     @PostMapping("/export")
+    @ApiOperation(value = "导出参数配置")
     public void export(HttpServletResponse response, SysConfig config)
     {
         List<SysConfig> list = configService.selectConfigList(config);
@@ -59,6 +65,7 @@ public class SysConfigController extends BaseController
     /**
      * 根据参数编号获取详细信息
      */
+    @ApiOperation(value = "根据参数编号获取详细信息")
     @PreAuthorize("@ss.hasPermi('system:config:query')")
     @GetMapping(value = "/{configId}")
     public AjaxResult getInfo(@PathVariable Long configId)
@@ -69,6 +76,7 @@ public class SysConfigController extends BaseController
     /**
      * 根据参数键名查询参数值
      */
+    @ApiOperation(value = "根据参数键名查询参数值")
     @GetMapping(value = "/configKey/{configKey}")
     public AjaxResult getConfigKey(@PathVariable String configKey)
     {
@@ -78,6 +86,7 @@ public class SysConfigController extends BaseController
     /**
      * 新增参数配置
      */
+    @ApiOperation(value = "新增参数配置")
     @PreAuthorize("@ss.hasPermi('system:config:add')")
     @Log(title = "参数管理", businessType = BusinessType.INSERT)
     @PostMapping
@@ -94,6 +103,7 @@ public class SysConfigController extends BaseController
     /**
      * 修改参数配置
      */
+    @ApiOperation(value = "修改参数配置")
     @PreAuthorize("@ss.hasPermi('system:config:edit')")
     @Log(title = "参数管理", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -110,6 +120,7 @@ public class SysConfigController extends BaseController
     /**
      * 删除参数配置
      */
+    @ApiOperation(value = "删除参数配置")
     @PreAuthorize("@ss.hasPermi('system:config:remove')")
     @Log(title = "参数管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{configIds}")
@@ -122,6 +133,7 @@ public class SysConfigController extends BaseController
     /**
      * 刷新参数缓存
      */
+    @ApiOperation(value = "刷新参数缓存")
     @PreAuthorize("@ss.hasPermi('system:config:remove')")
     @Log(title = "参数管理", businessType = BusinessType.CLEAN)
     @DeleteMapping("/refreshCache")

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysDeptController.java

@@ -1,6 +1,9 @@
 package com.zksy.web.controller.system;
 
 import java.util.List;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.apache.commons.lang3.ArrayUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
@@ -29,6 +32,7 @@ import com.zksy.system.service.ISysDeptService;
  */
 @RestController
 @RequestMapping("/system/dept")
+@Api(tags = "部门信息", description = "部门信息 desc")
 public class SysDeptController extends BaseController
 {
     @Autowired
@@ -39,6 +43,7 @@ public class SysDeptController extends BaseController
      */
     @PreAuthorize("@ss.hasPermi('system:dept:list')")
     @GetMapping("/list")
+    @ApiOperation(value = "获取部门列表", notes = "获取部门列表")
     public AjaxResult list(SysDept dept)
     {
         List<SysDept> depts = deptService.selectDeptList(dept);
@@ -50,6 +55,7 @@ public class SysDeptController extends BaseController
      */
     @PreAuthorize("@ss.hasPermi('system:dept:list')")
     @GetMapping("/list/exclude/{deptId}")
+    @ApiOperation(value = "查询部门列表（排除节点）", notes = "查询部门列表（排除节点）")
     public AjaxResult excludeChild(@PathVariable(value = "deptId", required = false) Long deptId)
     {
         List<SysDept> depts = deptService.selectDeptList(new SysDept());
@@ -62,6 +68,7 @@ public class SysDeptController extends BaseController
      */
     @PreAuthorize("@ss.hasPermi('system:dept:query')")
     @GetMapping(value = "/{deptId}")
+    @ApiOperation(value = "根据部门编号获取详细信息", notes = "根据部门编号获取详细信息")
     public AjaxResult getInfo(@PathVariable Long deptId)
     {
         deptService.checkDeptDataScope(deptId);
@@ -71,6 +78,7 @@ public class SysDeptController extends BaseController
     /**
      * 新增部门
      */
+    @ApiOperation(value = "新增部门", notes = "新增部门")
     @PreAuthorize("@ss.hasPermi('system:dept:add')")
     @Log(title = "部门管理", businessType = BusinessType.INSERT)
     @PostMapping
@@ -87,6 +95,7 @@ public class SysDeptController extends BaseController
     /**
      * 修改部门
      */
+    @ApiOperation(value = "修改部门", notes = "修改部门")
     @PreAuthorize("@ss.hasPermi('system:dept:edit')")
     @Log(title = "部门管理", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -113,6 +122,7 @@ public class SysDeptController extends BaseController
     /**
      * 删除部门
      */
+    @ApiOperation(value = "删除部门", notes = "删除部门")
     @PreAuthorize("@ss.hasPermi('system:dept:remove')")
     @Log(title = "部门管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{deptId}")

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysDictDataController.java

@@ -3,6 +3,9 @@ package com.zksy.web.controller.system;
 import java.util.ArrayList;
 import java.util.List;
 import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -30,6 +33,7 @@ import com.zksy.system.service.ISysDictTypeService;
  * 
  * @author ruoyi
  */
+@Api(tags = "数据字典信息", description = "数据字典信息desc")
 @RestController
 @RequestMapping("/system/dict/data")
 public class SysDictDataController extends BaseController
@@ -40,6 +44,7 @@ public class SysDictDataController extends BaseController
     @Autowired
     private ISysDictTypeService dictTypeService;
 
+    @ApiOperation(value = "数据字典信息列表", notes = "数据字典信息列表")
     @PreAuthorize("@ss.hasPermi('system:dict:list')")
     @GetMapping("/list")
     public TableDataInfo list(SysDictData dictData)
@@ -49,6 +54,7 @@ public class SysDictDataController extends BaseController
         return getDataTable(list);
     }
 
+    @ApiOperation(value = "导出字典数据", notes = "导出字典数据")
     @Log(title = "字典数据", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:dict:export')")
     @PostMapping("/export")
@@ -62,6 +68,7 @@ public class SysDictDataController extends BaseController
     /**
      * 查询字典数据详细
      */
+    @ApiOperation(value = "查询字典数据详细", notes = "查询字典数据详细")
     @PreAuthorize("@ss.hasPermi('system:dict:query')")
     @GetMapping(value = "/{dictCode}")
     public AjaxResult getInfo(@PathVariable Long dictCode)
@@ -72,6 +79,7 @@ public class SysDictDataController extends BaseController
     /**
      * 根据字典类型查询字典数据信息
      */
+    @ApiOperation(value = "根据字典类型查询字典数据信息", notes = "根据字典类型查询字典数据信息")
     @GetMapping(value = "/type/{dictType}")
     public AjaxResult dictType(@PathVariable String dictType)
     {
@@ -86,6 +94,7 @@ public class SysDictDataController extends BaseController
     /**
      * 新增字典类型
      */
+    @ApiOperation(value = "新增字典类型", notes = "新增字典类型")
     @PreAuthorize("@ss.hasPermi('system:dict:add')")
     @Log(title = "字典数据", businessType = BusinessType.INSERT)
     @PostMapping
@@ -98,6 +107,7 @@ public class SysDictDataController extends BaseController
     /**
      * 修改保存字典类型
      */
+    @ApiOperation(value = "修改保存字典类型", notes = "修改保存字典类型")
     @PreAuthorize("@ss.hasPermi('system:dict:edit')")
     @Log(title = "字典数据", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -110,6 +120,7 @@ public class SysDictDataController extends BaseController
     /**
      * 删除字典类型
      */
+    @ApiOperation(value = "删除字典类型", notes = "删除字典类型")
     @PreAuthorize("@ss.hasPermi('system:dict:remove')")
     @Log(title = "字典类型", businessType = BusinessType.DELETE)
     @DeleteMapping("/{dictCodes}")

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysDictTypeController.java

@@ -2,6 +2,9 @@ package com.zksy.web.controller.system;
 
 import java.util.List;
 import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -29,11 +32,13 @@ import com.zksy.system.service.ISysDictTypeService;
  */
 @RestController
 @RequestMapping("/system/dict/type")
+@Api(tags = "数据字典类型信息", description = "数据字典类型信息desc")
 public class SysDictTypeController extends BaseController
 {
     @Autowired
     private ISysDictTypeService dictTypeService;
 
+    @ApiOperation(value = "根据条件分页查询字典类型")
     @PreAuthorize("@ss.hasPermi('system:dict:list')")
     @GetMapping("/list")
     public TableDataInfo list(SysDictType dictType)
@@ -46,6 +51,7 @@ public class SysDictTypeController extends BaseController
     @Log(title = "字典类型", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:dict:export')")
     @PostMapping("/export")
+    @ApiOperation(value = "字典类型导出")
     public void export(HttpServletResponse response, SysDictType dictType)
     {
         List<SysDictType> list = dictTypeService.selectDictTypeList(dictType);
@@ -56,6 +62,7 @@ public class SysDictTypeController extends BaseController
     /**
      * 查询字典类型详细
      */
+    @ApiOperation(value = "查询字典类型详细")
     @PreAuthorize("@ss.hasPermi('system:dict:query')")
     @GetMapping(value = "/{dictId}")
     public AjaxResult getInfo(@PathVariable Long dictId)
@@ -66,6 +73,7 @@ public class SysDictTypeController extends BaseController
     /**
      * 新增字典类型
      */
+    @ApiOperation(value = "新增字典类型")
     @PreAuthorize("@ss.hasPermi('system:dict:add')")
     @Log(title = "字典类型", businessType = BusinessType.INSERT)
     @PostMapping
@@ -82,6 +90,7 @@ public class SysDictTypeController extends BaseController
     /**
      * 修改字典类型
      */
+    @ApiOperation(value = "修改字典类型")
     @PreAuthorize("@ss.hasPermi('system:dict:edit')")
     @Log(title = "字典类型", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -98,6 +107,7 @@ public class SysDictTypeController extends BaseController
     /**
      * 删除字典类型
      */
+    @ApiOperation(value = "字典类型")
     @PreAuthorize("@ss.hasPermi('system:dict:remove')")
     @Log(title = "字典类型", businessType = BusinessType.DELETE)
     @DeleteMapping("/{dictIds}")
@@ -110,6 +120,7 @@ public class SysDictTypeController extends BaseController
     /**
      * 刷新字典缓存
      */
+    @ApiOperation(value = "刷新字典缓存")
     @PreAuthorize("@ss.hasPermi('system:dict:remove')")
     @Log(title = "字典类型", businessType = BusinessType.CLEAN)
     @DeleteMapping("/refreshCache")
@@ -122,6 +133,7 @@ public class SysDictTypeController extends BaseController
     /**
      * 获取字典选择框列表
      */
+    @ApiOperation(value = "获取字典选择框列表")
     @GetMapping("/optionselect")
     public AjaxResult optionselect()
     {

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysLoginController.java

@@ -2,6 +2,9 @@ package com.zksy.web.controller.system;
 
 import java.util.List;
 import java.util.Set;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -22,6 +25,7 @@ import com.zksy.system.service.ISysMenuService;
  * 
  * @author ruoyi
  */
+@Api(tags = "用户登录", description = "用户登录desc")
 @RestController
 public class SysLoginController
 {
@@ -40,6 +44,7 @@ public class SysLoginController
      * @param loginBody 登录信息
      * @return 结果
      */
+    @ApiOperation(value = "用户通过验证码登录")
     @PostMapping("/login")
     public AjaxResult login(@RequestBody LoginBody loginBody)
     {
@@ -50,7 +55,7 @@ public class SysLoginController
         ajax.put(Constants.TOKEN, token);
         return ajax;
     }
-
+    @ApiOperation(value = "用户不需要验证码登录")
     @PostMapping("/loginNoNeedAuth")
     public AjaxResult loginNoNeedAuth(@RequestBody LoginBody loginBody) {
         AjaxResult ajax = AjaxResult.success();
@@ -66,6 +71,7 @@ public class SysLoginController
      * @return 用户信息
      */
     @GetMapping("getInfo")
+    @ApiOperation(value = "获取用户信息")
     public AjaxResult getInfo()
     {
         SysUser user = SecurityUtils.getLoginUser().getUser();
@@ -86,6 +92,7 @@ public class SysLoginController
      * @return 路由信息
      */
     @GetMapping("getRouters")
+    @ApiOperation(value = "获取路由信息")
     public AjaxResult getRouters()
     {
         Long userId = SecurityUtils.getUserId();

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysMenuController.java

@@ -1,6 +1,9 @@
 package com.zksy.web.controller.system;
 
 import java.util.List;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -26,6 +29,7 @@ import com.zksy.system.service.ISysMenuService;
  * 
  * @author ruoyi
  */
+@Api(tags = "菜单信息", description = "菜单信息desc")
 @RestController
 @RequestMapping("/system/menu")
 public class SysMenuController extends BaseController
@@ -36,6 +40,7 @@ public class SysMenuController extends BaseController
     /**
      * 获取菜单列表
      */
+    @ApiOperation(value = "获取菜单列表", notes = "获取菜单列表")
     @PreAuthorize("@ss.hasPermi('system:menu:list')")
     @GetMapping("/list")
     public AjaxResult list(SysMenu menu)
@@ -47,6 +52,7 @@ public class SysMenuController extends BaseController
     /**
      * 根据菜单编号获取详细信息
      */
+    @ApiOperation(value = "根据菜单编号获取详细信息", notes = "根据菜单编号获取详细信息")
     @PreAuthorize("@ss.hasPermi('system:menu:query')")
     @GetMapping(value = "/{menuId}")
     public AjaxResult getInfo(@PathVariable Long menuId)
@@ -57,6 +63,7 @@ public class SysMenuController extends BaseController
     /**
      * 获取菜单下拉树列表
      */
+    @ApiOperation(value = "获取菜单下拉树列表", notes = "获取菜单下拉树列表")
     @GetMapping("/treeselect")
     public AjaxResult treeselect(SysMenu menu)
     {
@@ -67,6 +74,7 @@ public class SysMenuController extends BaseController
     /**
      * 加载对应角色菜单列表树
      */
+    @ApiOperation(value = "加载对应角色菜单列表树", notes = "加载对应角色菜单列表树")
     @GetMapping(value = "/roleMenuTreeselect/{roleId}")
     public AjaxResult roleMenuTreeselect(@PathVariable("roleId") Long roleId)
     {
@@ -80,6 +88,7 @@ public class SysMenuController extends BaseController
     /**
      * 新增菜单
      */
+    @ApiOperation(value = "新增菜单", notes = "新增菜单")
     @PreAuthorize("@ss.hasPermi('system:menu:add')")
     @Log(title = "菜单管理", businessType = BusinessType.INSERT)
     @PostMapping
@@ -100,6 +109,7 @@ public class SysMenuController extends BaseController
     /**
      * 修改菜单
      */
+    @ApiOperation(value = "修改菜单", notes = "修改菜单")
     @PreAuthorize("@ss.hasPermi('system:menu:edit')")
     @Log(title = "菜单管理", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -124,6 +134,7 @@ public class SysMenuController extends BaseController
     /**
      * 删除菜单
      */
+    @ApiOperation(value = "删除菜单", notes = "删除菜单")
     @PreAuthorize("@ss.hasPermi('system:menu:remove')")
     @Log(title = "菜单管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{menuId}")

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysNoticeController.java

@@ -1,6 +1,9 @@
 package com.zksy.web.controller.system;
 
 import java.util.List;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -27,6 +30,7 @@ import com.zksy.system.service.ISysNoticeService;
  */
 @RestController
 @RequestMapping("/system/notice")
+@Api(tags = "公告信息", description = "公告信息desc")
 public class SysNoticeController extends BaseController
 {
     @Autowired
@@ -35,6 +39,7 @@ public class SysNoticeController extends BaseController
     /**
      * 获取通知公告列表
      */
+    @ApiOperation(value = "获取通知公告列表")
     @PreAuthorize("@ss.hasPermi('system:notice:list')")
     @GetMapping("/list")
     public TableDataInfo list(SysNotice notice)
@@ -47,6 +52,7 @@ public class SysNoticeController extends BaseController
     /**
      * 根据通知公告编号获取详细信息
      */
+    @ApiOperation(value = "根据通知公告编号获取详细信息")
     @PreAuthorize("@ss.hasPermi('system:notice:query')")
     @GetMapping(value = "/{noticeId}")
     public AjaxResult getInfo(@PathVariable Long noticeId)
@@ -57,6 +63,7 @@ public class SysNoticeController extends BaseController
     /**
      * 新增通知公告
      */
+    @ApiOperation(value = "新增通知公告")
     @PreAuthorize("@ss.hasPermi('system:notice:add')")
     @Log(title = "通知公告", businessType = BusinessType.INSERT)
     @PostMapping
@@ -69,6 +76,7 @@ public class SysNoticeController extends BaseController
     /**
      * 修改通知公告
      */
+    @ApiOperation(value = "修改通知公告")
     @PreAuthorize("@ss.hasPermi('system:notice:edit')")
     @Log(title = "通知公告", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -81,6 +89,7 @@ public class SysNoticeController extends BaseController
     /**
      * 删除通知公告
      */
+    @ApiOperation(value = "删除通知公告")
     @PreAuthorize("@ss.hasPermi('system:notice:remove')")
     @Log(title = "通知公告", businessType = BusinessType.DELETE)
     @DeleteMapping("/{noticeIds}")

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysPostController.java

@@ -2,6 +2,9 @@ package com.zksy.web.controller.system;
 
 import java.util.List;
 import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -29,6 +32,7 @@ import com.zksy.system.service.ISysPostService;
  */
 @RestController
 @RequestMapping("/system/post")
+@Api(tags = "岗位信息", description = "岗位信息desc")
 public class SysPostController extends BaseController
 {
     @Autowired
@@ -37,6 +41,7 @@ public class SysPostController extends BaseController
     /**
      * 获取岗位列表
      */
+    @ApiOperation(value = "查询岗位信息列表")
     @PreAuthorize("@ss.hasPermi('system:post:list')")
     @GetMapping("/list")
     public TableDataInfo list(SysPost post)
@@ -45,7 +50,8 @@ public class SysPostController extends BaseController
         List<SysPost> list = postService.selectPostList(post);
         return getDataTable(list);
     }
-    
+
+    @ApiOperation(value = "导出岗位信息")
     @Log(title = "岗位管理", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:post:export')")
     @PostMapping("/export")
@@ -59,6 +65,7 @@ public class SysPostController extends BaseController
     /**
      * 根据岗位编号获取详细信息
      */
+    @ApiOperation(value = "根据岗位编号获取详细信息")
     @PreAuthorize("@ss.hasPermi('system:post:query')")
     @GetMapping(value = "/{postId}")
     public AjaxResult getInfo(@PathVariable Long postId)
@@ -69,6 +76,7 @@ public class SysPostController extends BaseController
     /**
      * 新增岗位
      */
+    @ApiOperation(value = "新增岗位")
     @PreAuthorize("@ss.hasPermi('system:post:add')")
     @Log(title = "岗位管理", businessType = BusinessType.INSERT)
     @PostMapping
@@ -89,6 +97,7 @@ public class SysPostController extends BaseController
     /**
      * 修改岗位
      */
+    @ApiOperation(value = "修改岗位")
     @PreAuthorize("@ss.hasPermi('system:post:edit')")
     @Log(title = "岗位管理", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -109,6 +118,7 @@ public class SysPostController extends BaseController
     /**
      * 删除岗位
      */
+    @ApiOperation(value = "删除岗位")
     @PreAuthorize("@ss.hasPermi('system:post:remove')")
     @Log(title = "岗位管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{postIds}")
@@ -120,6 +130,7 @@ public class SysPostController extends BaseController
     /**
      * 获取岗位选择框列表
      */
+    @ApiOperation(value = "获取岗位选择框列表")
     @GetMapping("/optionselect")
     public AjaxResult optionselect()
     {

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysProfileController.java

@@ -1,5 +1,7 @@
 package com.zksy.web.controller.system;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -30,6 +32,7 @@ import com.zksy.system.service.ISysUserService;
  */
 @RestController
 @RequestMapping("/system/user/profile")
+@Api(tags = "个人信息", description = "个人信息desc")
 public class SysProfileController extends BaseController
 {
     @Autowired
@@ -41,6 +44,7 @@ public class SysProfileController extends BaseController
     /**
      * 个人信息
      */
+    @ApiOperation(value = "个人信息")
     @GetMapping
     public AjaxResult profile()
     {
@@ -55,6 +59,7 @@ public class SysProfileController extends BaseController
     /**
      * 修改用户
      */
+    @ApiOperation(value = "修改用户")
     @Log(title = "个人信息", businessType = BusinessType.UPDATE)
     @PutMapping
     public AjaxResult updateProfile(@RequestBody SysUser user)
@@ -85,6 +90,7 @@ public class SysProfileController extends BaseController
     /**
      * 重置密码
      */
+    @ApiOperation(value = "重置密码")
     @Log(title = "个人信息", businessType = BusinessType.UPDATE)
     @PutMapping("/updatePwd")
     public AjaxResult updatePwd(String oldPassword, String newPassword)
@@ -114,6 +120,7 @@ public class SysProfileController extends BaseController
     /**
      * 头像上传
      */
+    @ApiOperation(value = "头像上传")
     @Log(title = "用户头像", businessType = BusinessType.UPDATE)
     @PostMapping("/avatar")
     public AjaxResult avatar(@RequestParam("avatarfile") MultipartFile file) throws Exception

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysRegisterController.java

@@ -1,5 +1,7 @@
 package com.zksy.web.controller.system;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -17,6 +19,7 @@ import com.zksy.system.service.ISysConfigService;
  * @author ruoyi
  */
 @RestController
+@Api(tags = "注册", description = "注册desc")
 public class SysRegisterController extends BaseController
 {
     @Autowired
@@ -25,6 +28,7 @@ public class SysRegisterController extends BaseController
     @Autowired
     private ISysConfigService configService;
 
+    @ApiOperation(value = "用户注册")
     @PostMapping("/register")
     public AjaxResult register(@RequestBody RegisterBody user)
     {

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysRoleController.java

@@ -2,6 +2,9 @@ package com.zksy.web.controller.system;
 
 import java.util.List;
 import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -38,6 +41,7 @@ import com.zksy.system.service.ISysUserService;
  */
 @RestController
 @RequestMapping("/system/role")
+@Api(tags = "角色信息管理", description = "角色信息管理desc")
 public class SysRoleController extends BaseController
 {
     @Autowired
@@ -55,6 +59,7 @@ public class SysRoleController extends BaseController
     @Autowired
     private ISysDeptService deptService;
 
+    @ApiOperation(value = "角色信息列表", notes = "角色信息列表")
     @PreAuthorize("@ss.hasPermi('system:role:list')")
     @GetMapping("/list")
     public TableDataInfo list(SysRole role)
@@ -64,6 +69,7 @@ public class SysRoleController extends BaseController
         return getDataTable(list);
     }
 
+    @ApiOperation(value = "角色信息导出", notes = "角色信息导出")
     @Log(title = "角色管理", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:role:export')")
     @PostMapping("/export")
@@ -77,6 +83,7 @@ public class SysRoleController extends BaseController
     /**
      * 根据角色编号获取详细信息
      */
+    @ApiOperation(value = "根据角色编号获取详细信息", notes = "根据角色编号获取详细信息")
     @PreAuthorize("@ss.hasPermi('system:role:query')")
     @GetMapping(value = "/{roleId}")
     public AjaxResult getInfo(@PathVariable Long roleId)
@@ -88,6 +95,7 @@ public class SysRoleController extends BaseController
     /**
      * 新增角色
      */
+    @ApiOperation(value = "新增角色", notes = "新增角色")
     @PreAuthorize("@ss.hasPermi('system:role:add')")
     @Log(title = "角色管理", businessType = BusinessType.INSERT)
     @PostMapping
@@ -109,6 +117,7 @@ public class SysRoleController extends BaseController
     /**
      * 修改保存角色
      */
+    @ApiOperation(value = "修改保存角色", notes = "修改保存角色")
     @PreAuthorize("@ss.hasPermi('system:role:edit')")
     @Log(title = "角色管理", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -144,6 +153,7 @@ public class SysRoleController extends BaseController
     /**
      * 修改保存数据权限
      */
+    @ApiOperation(value = "修改保存数据权限", notes = "修改保存数据权限")
     @PreAuthorize("@ss.hasPermi('system:role:edit')")
     @Log(title = "角色管理", businessType = BusinessType.UPDATE)
     @PutMapping("/dataScope")
@@ -157,6 +167,7 @@ public class SysRoleController extends BaseController
     /**
      * 状态修改
      */
+    @ApiOperation(value = "状态修改", notes = "状态修改")
     @PreAuthorize("@ss.hasPermi('system:role:edit')")
     @Log(title = "角色管理", businessType = BusinessType.UPDATE)
     @PutMapping("/changeStatus")
@@ -171,6 +182,7 @@ public class SysRoleController extends BaseController
     /**
      * 删除角色
      */
+    @ApiOperation(value = "删除角色", notes = "删除角色")
     @PreAuthorize("@ss.hasPermi('system:role:remove')")
     @Log(title = "角色管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{roleIds}")
@@ -182,6 +194,7 @@ public class SysRoleController extends BaseController
     /**
      * 获取角色选择框列表
      */
+    @ApiOperation(value = "获取角色选择框列表", notes = "获取角色选择框列表")
     @PreAuthorize("@ss.hasPermi('system:role:query')")
     @GetMapping("/optionselect")
     public AjaxResult optionselect()
@@ -192,6 +205,7 @@ public class SysRoleController extends BaseController
     /**
      * 查询已分配用户角色列表
      */
+    @ApiOperation(value = "查询已分配用户角色列表", notes = "查询已分配用户角色列表")
     @PreAuthorize("@ss.hasPermi('system:role:list')")
     @GetMapping("/authUser/allocatedList")
     public TableDataInfo allocatedList(SysUser user)
@@ -204,6 +218,7 @@ public class SysRoleController extends BaseController
     /**
      * 查询未分配用户角色列表
      */
+    @ApiOperation(value = "查询未分配用户角色列表", notes = "查询未分配用户角色列表")
     @PreAuthorize("@ss.hasPermi('system:role:list')")
     @GetMapping("/authUser/unallocatedList")
     public TableDataInfo unallocatedList(SysUser user)
@@ -216,6 +231,7 @@ public class SysRoleController extends BaseController
     /**
      * 取消授权用户
      */
+    @ApiOperation(value = "取消授权用户", notes = "取消授权用户")
     @PreAuthorize("@ss.hasPermi('system:role:edit')")
     @Log(title = "角色管理", businessType = BusinessType.GRANT)
     @PutMapping("/authUser/cancel")
@@ -227,6 +243,7 @@ public class SysRoleController extends BaseController
     /**
      * 批量取消授权用户
      */
+    @ApiOperation(value = "批量取消授权用户", notes = "批量取消授权用户")
     @PreAuthorize("@ss.hasPermi('system:role:edit')")
     @Log(title = "角色管理", businessType = BusinessType.GRANT)
     @PutMapping("/authUser/cancelAll")
@@ -238,6 +255,7 @@ public class SysRoleController extends BaseController
     /**
      * 批量选择用户授权
      */
+    @ApiOperation(value = "批量选择用户授权", notes = "批量选择用户授权")
     @PreAuthorize("@ss.hasPermi('system:role:edit')")
     @Log(title = "角色管理", businessType = BusinessType.GRANT)
     @PutMapping("/authUser/selectAll")
@@ -250,6 +268,7 @@ public class SysRoleController extends BaseController
     /**
      * 获取对应角色部门树列表
      */
+    @ApiOperation(value = "获取对应角色部门树列表", notes = "获取对应角色部门树列表")
     @PreAuthorize("@ss.hasPermi('system:role:query')")
     @GetMapping(value = "/deptTree/{roleId}")
     public AjaxResult deptTree(@PathVariable("roleId") Long roleId)

background-service/zksy-admin/src/main/java/com/zksy/web/controller/system/SysUserController.java

@@ -3,6 +3,9 @@ package com.zksy.web.controller.system;
 import java.util.List;
 import java.util.stream.Collectors;
 import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.apache.commons.lang3.ArrayUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
@@ -39,6 +42,7 @@ import com.zksy.system.service.ISysUserService;
  */
 @RestController
 @RequestMapping("/system/user")
+@Api(tags = "用户信息", description = "用户信息desc")
 public class SysUserController extends BaseController
 {
     @Autowired
@@ -56,6 +60,7 @@ public class SysUserController extends BaseController
     /**
      * 获取用户列表
      */
+    @ApiOperation(value = "获取用户列表")
     @PreAuthorize("@ss.hasPermi('system:user:list')")
     @GetMapping("/list")
     public TableDataInfo list(SysUser user)
@@ -65,6 +70,7 @@ public class SysUserController extends BaseController
         return getDataTable(list);
     }
 
+    @ApiOperation(value = "用户数据导出")
     @Log(title = "用户管理", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:user:export')")
     @PostMapping("/export")
@@ -75,6 +81,7 @@ public class SysUserController extends BaseController
         util.exportExcel(response, list, "用户数据");
     }
 
+    @ApiOperation(value = "用户数据导入")
     @Log(title = "用户管理", businessType = BusinessType.IMPORT)
     @PreAuthorize("@ss.hasPermi('system:user:import')")
     @PostMapping("/importData")
@@ -87,6 +94,7 @@ public class SysUserController extends BaseController
         return success(message);
     }
 
+    @ApiOperation(value = "用户数据导入模板")
     @PostMapping("/importTemplate")
     public void importTemplate(HttpServletResponse response)
     {
@@ -97,6 +105,7 @@ public class SysUserController extends BaseController
     /**
      * 根据用户编号获取详细信息
      */
+    @ApiOperation(value = "根据用户编号获取详细信息")
     @PreAuthorize("@ss.hasPermi('system:user:query')")
     @GetMapping(value = { "/", "/{userId}" })
     public AjaxResult getInfo(@PathVariable(value = "userId", required = false) Long userId)
@@ -119,6 +128,7 @@ public class SysUserController extends BaseController
     /**
      * 新增用户
      */
+    @ApiOperation(value = "用户新增")
     @PreAuthorize("@ss.hasPermi('system:user:add')")
     @Log(title = "用户管理", businessType = BusinessType.INSERT)
     @PostMapping
@@ -146,6 +156,7 @@ public class SysUserController extends BaseController
     /**
      * 修改用户
      */
+    @ApiOperation(value = "修改用户")
     @PreAuthorize("@ss.hasPermi('system:user:edit')")
     @Log(title = "用户管理", businessType = BusinessType.UPDATE)
     @PutMapping
@@ -174,6 +185,7 @@ public class SysUserController extends BaseController
     /**
      * 删除用户
      */
+    @ApiOperation(value = "删除用户")
     @PreAuthorize("@ss.hasPermi('system:user:remove')")
     @Log(title = "用户管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{userIds}")
@@ -189,6 +201,7 @@ public class SysUserController extends BaseController
     /**
      * 重置密码
      */
+    @ApiOperation(value = "重置密码（有权限控制）")
     @PreAuthorize("@ss.hasPermi('system:user:resetPwd')")
     @Log(title = "用户管理", businessType = BusinessType.UPDATE)
     @PutMapping("/resetPwd")
@@ -204,6 +217,7 @@ public class SysUserController extends BaseController
     /**
      * 状态修改
      */
+    @ApiOperation(value = "账号状态修改")
     @PreAuthorize("@ss.hasPermi('system:user:edit')")
     @Log(title = "用户管理", businessType = BusinessType.UPDATE)
     @PutMapping("/changeStatus")
@@ -218,6 +232,7 @@ public class SysUserController extends BaseController
     /**
      * 根据用户编号获取授权角色
      */
+    @ApiOperation(value = "根据用户编号获取授权角色")
     @PreAuthorize("@ss.hasPermi('system:user:query')")
     @GetMapping("/authRole/{userId}")
     public AjaxResult authRole(@PathVariable("userId") Long userId)
@@ -233,6 +248,7 @@ public class SysUserController extends BaseController
     /**
      * 用户授权角色
      */
+    @ApiOperation(value = "用户授权角色")
     @PreAuthorize("@ss.hasPermi('system:user:edit')")
     @Log(title = "用户管理", businessType = BusinessType.GRANT)
     @PutMapping("/authRole")
@@ -247,6 +263,7 @@ public class SysUserController extends BaseController
     /**
      * 获取部门树列表
      */
+    @ApiOperation(value = "获取部门树列表")
     @PreAuthorize("@ss.hasPermi('system:user:list')")
     @GetMapping("/deptTree")
     public AjaxResult deptTree(SysDept dept)