【ADD】增加基础数据接口文档

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

@@ -1,5 +1,6 @@
 package com.railway.common.core.domain.entity;
 
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import javax.validation.constraints.*;
 import lombok.Data;
@@ -15,6 +16,7 @@ import com.railway.common.core.domain.BaseEntity;
  */
 @EqualsAndHashCode(callSuper = true)
 @Data
+@ApiModel("字典数据")
 public class SysDictData extends BaseEntity {
 
   private static final long serialVersionUID = 1L;

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

@@ -3,6 +3,7 @@ package com.railway.common.core.domain.entity;
 import com.railway.common.annotation.Excel;
 import com.railway.common.annotation.Excel.ColumnType;
 import com.railway.common.core.domain.BaseEntity;
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
@@ -16,6 +17,7 @@ import lombok.EqualsAndHashCode;
  */
 @EqualsAndHashCode(callSuper = true)
 @Data
+@ApiModel("字典类型")
 public class SysDictType extends BaseEntity {
 
   private static final long serialVersionUID = 1L;

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

@@ -1,5 +1,6 @@
 package com.railway.common.core.domain.entity;
 
+import io.swagger.annotations.ApiModel;
 import java.util.List;
 import java.util.ArrayList;
 import javax.validation.constraints.*;
@@ -14,6 +15,7 @@ import com.railway.common.core.domain.BaseEntity;
  */
 @EqualsAndHashCode(callSuper = true)
 @Data
+@ApiModel("菜单")
 public class SysMenu extends BaseEntity {
 
   private static final long serialVersionUID = 1L;

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

@@ -3,6 +3,7 @@ package com.railway.common.core.domain.entity;
 import com.railway.common.annotation.Excel;
 import com.railway.common.annotation.Excel.ColumnType;
 import com.railway.common.core.domain.BaseEntity;
+import io.swagger.annotations.ApiModel;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
 import lombok.Data;
@@ -15,6 +16,7 @@ import lombok.EqualsAndHashCode;
  */
 @EqualsAndHashCode(callSuper = true)
 @Data
+@ApiModel("角色(职务)")
 public class SysRole extends BaseEntity {
 
   private static final long serialVersionUID = 1L;

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

@@ -6,6 +6,7 @@ import com.railway.common.annotation.Excel.ColumnType;
 import com.railway.common.annotation.Excel.Type;
 import com.railway.common.annotation.Excels;
 import com.railway.common.core.domain.BaseEntity;
+import io.swagger.annotations.ApiModel;
 import java.util.Date;
 import java.util.List;
 import javax.validation.constraints.Email;
@@ -21,6 +22,7 @@ import lombok.EqualsAndHashCode;
  */
 @EqualsAndHashCode(callSuper = true)
 @Data
+@ApiModel("用户信息")
 public class SysUser extends BaseEntity {
 
   private static final long serialVersionUID = 1L;

railway-common/src/main/java/com/railway/common/core/domain/model/LoginUser.java

@@ -2,6 +2,8 @@ package com.railway.common.core.domain.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.railway.common.core.domain.entity.SysUser;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import java.util.Collection;
 import java.util.Set;
 import lombok.Data;
@@ -13,6 +15,7 @@ import org.springframework.security.core.userdetails.UserDetails;
  *
  * @author railway
  */
+@ApiModel("用户登录成功信息")
 @Data
 public class LoginUser implements UserDetails {
 
@@ -21,56 +24,67 @@ public class LoginUser implements UserDetails {
   /**
    * 用户ID
    */
+  @ApiModelProperty(value = "用户ID")
   private Long userId;
 
   /**
    * 部门ID
    */
+  @ApiModelProperty(value = "部门ID")
   private Long deptId;
 
   /**
    * 用户唯一标识
    */
+  @ApiModelProperty(value = "用户唯一标识")
   private String token;
 
   /**
    * 登录时间
    */
+  @ApiModelProperty(value = "登录时间")
   private Long loginTime;
 
   /**
    * 过期时间
    */
+  @ApiModelProperty(value = "过期时间")
   private Long expireTime;
 
   /**
    * 登录IP地址
    */
+  @ApiModelProperty(value = "登录IP地址")
   private String ipaddr;
 
   /**
    * 登录地点
    */
+  @ApiModelProperty(value = "登录地点")
   private String loginLocation;
 
   /**
    * 浏览器类型
    */
+  @ApiModelProperty(value = "浏览器类型")
   private String browser;
 
   /**
    * 操作系统
    */
+  @ApiModelProperty(value = "操作系统")
   private String os;
 
   /**
    * 权限列表
    */
+  @ApiModelProperty(value = "权限列表")
   private Set<String> permissions;
 
   /**
    * 用户信息
    */
+  @ApiModelProperty(value = "用户信息")
   private SysUser user;
 
   public LoginUser() {

railway-common/src/main/java/com/railway/common/core/domain/model/RegisterBody.java

@@ -1,5 +1,6 @@
 package com.railway.common.core.domain.model;
 
+import io.swagger.annotations.ApiModel;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -10,6 +11,7 @@ import lombok.EqualsAndHashCode;
  */
 @EqualsAndHashCode(callSuper = true)
 @Data
+@ApiModel("用户注册信息")
 public class RegisterBody extends LoginBody {
 
 }

railway-common/src/main/java/com/railway/common/core/page/PageDomain.java

@@ -1,6 +1,8 @@
 package com.railway.common.core.page;
 
 import com.railway.common.utils.StringUtils;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -8,27 +10,32 @@ import lombok.Data;
  *
  * @author railway
  */
+@ApiModel("分页数据")
 @Data
 public class PageDomain {
 
   /**
    * 当前记录起始索引
    */
+  @ApiModelProperty(value = "当前记录起始索引")
   private Integer pageNum;
 
   /**
    * 每页显示记录数
    */
+  @ApiModelProperty(value = "每页显示记录数")
   private Integer pageSize;
 
   /**
    * 排序列
    */
+  @ApiModelProperty(value = "排序列")
   private String orderByColumn;
 
   /**
    * 排序的方向desc或者asc
    */
+  @ApiModelProperty(value = "排序的方向desc或者asc")
   private String isAsc = "asc";
 
   /**

railway-common/src/main/java/com/railway/common/core/page/TableDataInfo.java

@@ -1,5 +1,7 @@
 package com.railway.common.core.page;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import java.io.Serializable;
 import java.util.List;
 import lombok.Data;
@@ -9,6 +11,7 @@ import lombok.Data;
  *
  * @author railway
  */
+@ApiModel("表格分页数据对象")
 @Data
 public class TableDataInfo implements Serializable {
 
@@ -17,21 +20,25 @@ public class TableDataInfo implements Serializable {
   /**
    * 总记录数
    */
+  @ApiModelProperty(value = "总记录数")
   private long total;
 
   /**
    * 列表数据
    */
+  @ApiModelProperty(value = "列表数据")
   private List<?> rows;
 
   /**
    * 消息状态码
    */
+  @ApiModelProperty(value = "消息状态码")
   private int code;
 
   /**
    * 消息内容
    */
+  @ApiModelProperty(value = "消息内容")
   private String msg;
 
   /**