fix: 补充api文档

shuili-admin/src/main/java/com/kms/web/controller/system/SysRoleController.java

@@ -15,6 +15,7 @@ import com.shuili.common.core.domain.SearchParam;
 import com.shuili.common.core.domain.entity.SysRole;
 import com.shuili.common.enums.BusinessType;
 import com.shuili.common.utils.poi.ExcelUtil;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
@@ -28,8 +29,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("/system/role")
-public class SysRoleController extends BaseController
-{
+public class SysRoleController extends BaseController {
     @Autowired
     private SysRoleService roleService;
     @Autowired
@@ -44,19 +44,21 @@ public class SysRoleController extends BaseController
 
     //获取所有的角色
     @GetMapping("listAll")
-    public  AjaxResult listAll(){
+    @ApiOperation("获取所有的角色")
+    public AjaxResult listAll() {
         return AjaxResult.success(roleService.list());
     }
 
 
     @PostMapping("/list")
-    public IPage list(@RequestBody SearchParam<SysRole> sp)
-    {
+    @ApiOperation("角色列表")
+    public IPage list(@RequestBody SearchParam<SysRole> sp) {
         return roleService.selectPage(sp);
     }
 
     /**
      * 角色导出
+     *
      * @param role
      * @return
      */
@@ -64,8 +66,7 @@ public class SysRoleController extends BaseController
     @Log(title = "角色管理", businessType = BusinessType.EXPORT)
     @SaCheckPermission(value = "system:role:export")
     @PostMapping("/export")
-    public AjaxResult export(@RequestBody  SysRole role)
-    {
+    public AjaxResult export(@RequestBody SysRole role) {
         List<SysRole> list = roleService.listByIds(role.getIds());
         ExcelUtil<SysRole> util = new ExcelUtil<SysRole>(SysRole.class);
         return util.exportExcel(list, "角色数据");
@@ -77,8 +78,7 @@ public class SysRoleController extends BaseController
     @SaCheckLogin
     @SaCheckPermission(value = "system:role:query")
     @GetMapping(value = "/{roleId}")
-    public AjaxResult getInfo(@PathVariable String roleId)
-    {
+    public AjaxResult getInfo(@PathVariable String roleId) {
         /**
          * 1.角色详情
          * 2.角色相关的菜单
@@ -104,17 +104,13 @@ public class SysRoleController extends BaseController
     @Log(title = "角色管理", businessType = BusinessType.INSERT)
     @SaCheckPermission(value = "system:role:add")
     @PostMapping
-    public AjaxResult add(@Validated @RequestBody SysRole role)
-    {
-        if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role)))
-        {
+    public AjaxResult add(@Validated @RequestBody SysRole role) {
+        if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role))) {
             return AjaxResult.error("新增角色'" + role.getRoleName() + "'失败，角色名称已存在");
-        }
-        else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role)))
-        {
+        } else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role))) {
             return AjaxResult.error("新增角色'" + role.getRoleName() + "'失败，角色权限已存在");
         }
-        return toAjax(roleService.insertRole(role)>0);
+        return toAjax(roleService.insertRole(role) > 0);
 
     }
 
@@ -125,20 +121,15 @@ public class SysRoleController extends BaseController
     @Log(title = "角色管理", businessType = BusinessType.UPDATE)
     @SaCheckPermission(value = "system:role:edit")
     @PutMapping
-    public AjaxResult edit(@Validated @RequestBody SysRole role)
-    {
+    public AjaxResult edit(@Validated @RequestBody SysRole role) {
         roleService.checkRoleAllowed(role);
-        if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role)))
-        {
+        if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role))) {
             return AjaxResult.error("修改角色'" + role.getRoleName() + "'失败，角色名称已存在");
-        }
-        else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role)))
-        {
+        } else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role))) {
             return AjaxResult.error("修改角色'" + role.getRoleName() + "'失败，角色权限已存在");
         }
 
-        if (roleService.updateRole(role) > 0)
-        {
+        if (roleService.updateRole(role) > 0) {
             // 更新缓存用户权限
 
 //            SysUser user = UserUtils.getUser();
@@ -160,10 +151,9 @@ public class SysRoleController extends BaseController
     @Log(title = "角色管理", businessType = BusinessType.UPDATE)
     @SaCheckPermission(value = "system:role:edit")
     @PutMapping("/dataScope")
-    public AjaxResult dataScope(@RequestBody SysRole role)
-    {
+    public AjaxResult dataScope(@RequestBody SysRole role) {
         roleService.checkRoleAllowed(role);
-        return toAjax(roleService.authDataScope(role)>0);
+        return toAjax(roleService.authDataScope(role) > 0);
     }
 
     /**
@@ -173,8 +163,7 @@ public class SysRoleController extends BaseController
     @Log(title = "角色管理", businessType = BusinessType.UPDATE)
     @SaCheckPermission(value = "system:role:edit")
     @PutMapping("/changeStatus")
-    public AjaxResult changeStatus(@RequestBody SysRole role)
-    {
+    public AjaxResult changeStatus(@RequestBody SysRole role) {
         roleService.checkRoleAllowed(role);
         return toAjax(roleService.updateRoleStatus(role) > 0);
     }
@@ -186,17 +175,15 @@ public class SysRoleController extends BaseController
     @Log(title = "角色管理", businessType = BusinessType.DELETE)
     @SaCheckPermission(value = "system:role:remove")
     @DeleteMapping("/{roleIds}")
-    public AjaxResult remove(@PathVariable String[] roleIds)
-    {
-        return toAjax(roleService.deleteRoleByIds(roleIds) >0);
+    public AjaxResult remove(@PathVariable String[] roleIds) {
+        return toAjax(roleService.deleteRoleByIds(roleIds) > 0);
     }
 
     /**
      * 获取角色选择框列表
      */
     @GetMapping("/optionselect")
-    public AjaxResult optionselect()
-    {
+    public AjaxResult optionselect() {
         return AjaxResult.success(roleService.selectRoleAll());
     }
 }