【ADD】增加系统管理接口文档

railway-admin/src/main/java/com/railway/web/controller/system/SysMenuController.java

@@ -9,6 +9,7 @@ import com.railway.common.enums.BusinessType;
 import com.railway.common.utils.StringUtils;
 import com.railway.system.service.ISysMenuService;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import java.util.List;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -26,7 +27,7 @@ import org.springframework.web.bind.annotation.RestController;
  *
  * @author railway
  */
-@Api(tags = "菜单")
+@Api(tags = "系统管理 - 菜单")
 @RestController
 @RequestMapping("/system/menu")
 public class SysMenuController extends BaseController {
@@ -40,6 +41,7 @@ public class SysMenuController extends BaseController {
   /**
    * 获取菜单列表
    */
+  @ApiOperation(value = "菜单列表", response = AjaxResult.class)
   @PreAuthorize("@ss.hasPermi('system:menu:list')")
   @GetMapping("/list")
   public AjaxResult list(SysMenu menu) {
@@ -50,6 +52,7 @@ public class SysMenuController extends BaseController {
   /**
    * 根据菜单编号获取详细信息
    */
+  @ApiOperation(value = "根据菜单编号获取详细信息", response = AjaxResult.class)
   @PreAuthorize("@ss.hasPermi('system:menu:query')")
   @GetMapping(value = "/{menuId}")
   public AjaxResult getInfo(@PathVariable Long menuId) {
@@ -59,6 +62,7 @@ public class SysMenuController extends BaseController {
   /**
    * 获取菜单下拉树列表
    */
+  @ApiOperation(value = "获取菜单下拉树列表", response = AjaxResult.class)
   @GetMapping("/treeselect")
   public AjaxResult treeselect(SysMenu menu) {
     List<SysMenu> menus = menuService.selectMenuList(menu, getUserId());
@@ -68,6 +72,7 @@ public class SysMenuController extends BaseController {
   /**
    * 加载对应角色菜单列表树
    */
+  @ApiOperation(value = "加载对应角色菜单列表树", response = AjaxResult.class)
   @GetMapping(value = "/roleMenuTreeselect/{roleId}")
   public AjaxResult roleMenuTreeselect(@PathVariable("roleId") Long roleId) {
     List<SysMenu> menus = menuService.selectMenuList(getUserId());
@@ -80,6 +85,7 @@ public class SysMenuController extends BaseController {
   /**
    * 新增菜单
    */
+  @ApiOperation(value = "新增菜单", response = AjaxResult.class)
   @PreAuthorize("@ss.hasPermi('system:menu:add')")
   @Log(title = "菜单管理", businessType = BusinessType.INSERT)
   @PostMapping
@@ -97,6 +103,7 @@ public class SysMenuController extends BaseController {
   /**
    * 修改菜单
    */
+  @ApiOperation(value = "修改菜单", response = AjaxResult.class)
   @PreAuthorize("@ss.hasPermi('system:menu:edit')")
   @Log(title = "菜单管理", businessType = BusinessType.UPDATE)
   @PutMapping
@@ -116,6 +123,7 @@ public class SysMenuController extends BaseController {
   /**
    * 删除菜单
    */
+  @ApiOperation(value = "删除菜单", response = AjaxResult.class)
   @PreAuthorize("@ss.hasPermi('system:menu:remove')")
   @Log(title = "菜单管理", businessType = BusinessType.DELETE)
   @DeleteMapping("/{menuId}")

railway-common/src/main/java/com/railway/common/core/domain/entity/SysMenu.java

@@ -1,6 +1,7 @@
 package com.railway.common.core.domain.entity;
 
 import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import java.util.List;
 import java.util.ArrayList;
 import javax.validation.constraints.*;
@@ -23,11 +24,13 @@ public class SysMenu extends BaseEntity {
   /**
    * 菜单ID
    */
+  @ApiModelProperty(value = "菜单ID")
   private Long menuId;
 
   /**
    * 菜单名称
    */
+  @ApiModelProperty(value = "菜单名称")
   @NotBlank(message = "菜单名称不能为空")
   @Size(max = 50, message = "菜单名称长度不能超过50个字符")
   private String menuName;
@@ -40,11 +43,13 @@ public class SysMenu extends BaseEntity {
   /**
    * 父菜单ID
    */
+  @ApiModelProperty(value = "父菜单ID")
   private Long parentId;
 
   /**
    * 显示顺序
    */
+  @ApiModelProperty(value = "显示顺序")
   @NotBlank(message = "显示顺序不能为空")
   private String orderNum;
 
@@ -76,6 +81,7 @@ public class SysMenu extends BaseEntity {
   /**
    * 菜单URL
    */
+  @ApiModelProperty(value = "菜单URL")
   @Size(max = 200, message = "请求地址不能超过200个字符")
   private String url;
 
@@ -108,6 +114,7 @@ public class SysMenu extends BaseEntity {
   /**
    * 权限字符串
    */
+  @ApiModelProperty(value = "权限字符串")
   @Size(max = 100, message = "权限标识长度不能超过100个字符")
   private String perms;
 

railway-system/src/main/java/com/railway/system/service/ISysDictTypeService.java

@@ -54,7 +54,6 @@ public interface ISysDictTypeService {
    * 批量删除字典信息
    *
    * @param dictIds 需要删除的字典ID
-   * @return 结果
    */
   void deleteDictTypeByIds(Long[] dictIds);