From 1bfff15a4e4a9fa399efcb0a8c5bc08192c0ecff Mon Sep 17 00:00:00 2001 From: lishangbu Date: Tue, 2 Jul 2019 22:28:12 +0800 Subject: [PATCH 1/2] =?UTF-8?q?:art:=20Improving=20structure=20/=20format?= =?UTF-8?q?=20of=20the=20code.=E4=BF=AE=E6=AD=A3=E9=83=A8=E5=88=86?= =?UTF-8?q?=E5=AE=9E=E4=BD=93=E5=B1=9E=E6=80=A7=E9=94=99=E8=AF=AF=E6=B3=A8?= =?UTF-8?q?=E9=87=8A,=E7=A7=BB=E9=99=A4=E8=8F=9C=E5=8D=95=E6=A0=91?= =?UTF-8?q?=E5=AE=9E=E4=BD=93=E4=B8=8A=E9=83=A8=E5=88=86=E6=97=A0=E7=94=A8?= =?UTF-8?q?=E5=B1=9E=E6=80=A7,=E6=B7=BB=E5=8A=A0swagger=E5=AE=9E=E4=BD=93?= =?UTF-8?q?=E5=B1=9E=E6=80=A7=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../pig4cloud/pigx/common/core/util/R.java | 2 +- .../pigx/admin/api/dto/DeptTree.java | 4 ++ .../pigx/admin/api/dto/MenuTree.java | 37 ++++++++++++++++++- .../pigx/admin/api/dto/TreeNode.java | 6 +++ .../pig4cloud/pigx/admin/api/dto/UserDTO.java | 11 +++++- .../pigx/admin/api/dto/UserInfo.java | 13 +++---- .../pigx/admin/api/entity/SysDept.java | 15 +++++++- .../admin/api/entity/SysDeptRelation.java | 6 ++- .../pigx/admin/api/entity/SysDict.java | 12 ++++++ .../pigx/admin/api/entity/SysDictItem.java | 19 ++++++++-- .../pigx/admin/api/entity/SysFile.java | 14 ++++++- .../pigx/admin/api/entity/SysLog.java | 23 ++++++++++-- .../pigx/admin/api/entity/SysMenu.java | 17 ++++++++- .../api/entity/SysOauthClientDetails.java | 37 ++++++++++--------- .../pigx/admin/api/entity/SysPublicParam.java | 22 ++--------- .../pigx/admin/api/entity/SysRole.java | 36 ++++++++++++------ .../pigx/admin/api/entity/SysRoleMenu.java | 6 ++- .../pigx/admin/api/entity/SysRouteConf.java | 13 +++++++ .../admin/api/entity/SysSocialDetails.java | 14 ++++++- .../pigx/admin/api/entity/SysTenant.java | 16 ++++++-- .../pigx/admin/api/entity/SysUser.java | 33 ++++++++++++----- .../pigx/admin/api/entity/SysUserRole.java | 6 ++- .../pigx/admin/api/vo/ImageCode.java | 19 +++++++++- .../pig4cloud/pigx/admin/api/vo/LogVO.java | 5 +++ .../pig4cloud/pigx/admin/api/vo/MenuVO.java | 17 ++++++++- .../pig4cloud/pigx/admin/api/vo/ParamVo.java | 6 +++ .../pig4cloud/pigx/admin/api/vo/PreLogVo.java | 31 ++++++++++++++++ .../pig4cloud/pigx/admin/api/vo/UserVO.java | 29 ++++++++++----- 28 files changed, 368 insertions(+), 101 deletions(-) diff --git a/pigx-common/pigx-common-core/src/main/java/com/pig4cloud/pigx/common/core/util/R.java b/pigx-common/pigx-common-core/src/main/java/com/pig4cloud/pigx/common/core/util/R.java index dcfd2b350..09b511c19 100644 --- a/pigx-common/pigx-common-core/src/main/java/com/pig4cloud/pigx/common/core/util/R.java +++ b/pigx-common/pigx-common-core/src/main/java/com/pig4cloud/pigx/common/core/util/R.java @@ -37,7 +37,7 @@ import java.io.Serializable; @NoArgsConstructor @AllArgsConstructor @Accessors(chain = true) -@ApiModel(description = "响应信息主体") +@ApiModel(value = "响应信息主体") public class R implements Serializable { private static final long serialVersionUID = 1L; diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/DeptTree.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/DeptTree.java index 107743b13..0a0b4d0e3 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/DeptTree.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/DeptTree.java @@ -19,6 +19,8 @@ package com.pig4cloud.pigx.admin.api.dto; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -28,7 +30,9 @@ import lombok.EqualsAndHashCode; * 部门树 */ @Data +@ApiModel(value = "部门树") @EqualsAndHashCode(callSuper = true) public class DeptTree extends TreeNode { + @ApiModelProperty(value = "部门名称") private String name; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/MenuTree.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/MenuTree.java index b2ee60729..9a1504e72 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/MenuTree.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/MenuTree.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.dto; import com.pig4cloud.pigx.admin.api.vo.MenuVO; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -28,18 +30,49 @@ import lombok.EqualsAndHashCode; * @date 2017年11月9日23:33:27 */ @Data +@ApiModel(value = "菜单树") @EqualsAndHashCode(callSuper = true) public class MenuTree extends TreeNode { + /** + * 菜单图标 + */ + @ApiModelProperty(value = "菜单图标") private String icon; + /** + * 菜单名称 + */ + @ApiModelProperty(value = "菜单名称") private String name; private boolean spread = false; + /** + * 前端路由标识路径 + */ + @ApiModelProperty(value = "前端路由标识路径") private String path; - private String authority; - private String redirect; + /** + * 路由缓冲 + */ + @ApiModelProperty(value = "路由缓冲") private String keepAlive; + /** + * 权限编码 + */ + @ApiModelProperty(value = "权限编码") private String code; + /** + * 菜单类型 （0菜单 1按钮） + */ + @ApiModelProperty(value = "菜单类型,0:菜单 1:按钮") private String type; + /** + * 菜单标签 + */ + @ApiModelProperty(value = "菜单标签") private String label; + /** + * 排序值 + */ + @ApiModelProperty(value = "排序值") private Integer sort; public MenuTree() { diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/TreeNode.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/TreeNode.java index d578da2f8..6685aab07 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/TreeNode.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/TreeNode.java @@ -19,6 +19,8 @@ package com.pig4cloud.pigx.admin.api.dto; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.ArrayList; @@ -29,9 +31,13 @@ import java.util.List; * @date 2017年11月9日23:33:45 */ @Data +@ApiModel(value = "树形节点") public class TreeNode { + @ApiModelProperty(value = "当前节点id") protected int id; + @ApiModelProperty(value = "父节点id") protected int parentId; + @ApiModelProperty(value = "子节点列表") protected List children = new ArrayList(); public void add(TreeNode node) { diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserDTO.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserDTO.java index 230227898..c1ed082a3 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserDTO.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserDTO.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.dto; import com.pig4cloud.pigx.admin.api.entity.SysUser; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -30,17 +32,22 @@ import java.util.List; * @date 2017/11/5 */ @Data +@ApiModel(value = "系统用户传输对象") @EqualsAndHashCode(callSuper = true) public class UserDTO extends SysUser { /** * 角色ID */ + @ApiModelProperty(value = "角色id集合") private List role; - + /** + * 部门id + */ + @ApiModelProperty(value = "部门id") private Integer deptId; - /** * 新密码 */ + @ApiModelProperty(value = "新密码") private String newpassword1; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserInfo.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserInfo.java index c0f0df0e6..b67d03c13 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserInfo.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/dto/UserInfo.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.dto; import com.pig4cloud.pigx.admin.api.entity.SysUser; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -27,26 +29,23 @@ import java.io.Serializable; /** * @author lengleng * @date 2017/11/11 - *

- * commit('SET_ROLES', data) - * commit('SET_NAME', data) - * commit('SET_AVATAR', data) - * commit('SET_INTRODUCTION', data) - * commit('SET_PERMISSIONS', data) */ @Data +@ApiModel(value = "用户信息") public class UserInfo implements Serializable { /** * 用户基本信息 */ + @ApiModelProperty(value = "用户基本信息") private SysUser sysUser; /** * 权限标识集合 */ + @ApiModelProperty(value = "权限标识集合") private String[] permissions; - /** * 角色集合 */ + @ApiModelProperty(value = "角色标识集合") private Integer[] roles; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDept.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDept.java index f4df30a49..87127d46d 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDept.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDept.java @@ -23,6 +23,8 @@ import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -39,38 +41,47 @@ import java.time.LocalDateTime; * @since 2018-01-22 */ @Data +@ApiModel(value = "部门") @EqualsAndHashCode(callSuper = true) public class SysDept extends Model { private static final long serialVersionUID = 1L; @TableId(value = "dept_id", type = IdType.AUTO) + @ApiModelProperty(value = "部门id") private Integer deptId; /** * 部门名称 */ @NotBlank(message = "部门名称不能为空") + @ApiModelProperty(value = "部门名称") private String name; /** * 排序 */ @NotEmpty(message = "排序值不能为空") + @ApiModelProperty(value = "排序值") private Integer sort; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 修改时间 */ + @ApiModelProperty(value = "修改时间") private LocalDateTime updateTime; - + /** + * 父级部门id + */ + @ApiModelProperty(value = "父级部门id") private Integer parentId; - /** * 是否删除 -1：已删除 0：正常 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDeptRelation.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDeptRelation.java index f51f608c8..c5e1aae08 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDeptRelation.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDeptRelation.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.entity; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -32,18 +34,20 @@ import lombok.EqualsAndHashCode; * @since 2018-01-22 */ @Data +@ApiModel(value = "部门关系") @EqualsAndHashCode(callSuper = true) public class SysDeptRelation extends Model { private static final long serialVersionUID = 1L; - /** * 祖先节点 */ + @ApiModelProperty(value = "祖先节点") private Integer ancestor; /** * 后代节点 */ + @ApiModelProperty(value = "后代节点") private Integer descendant; diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDict.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDict.java index 5d08a6d57..7ab314d3f 100755 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDict.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDict.java @@ -20,6 +20,8 @@ import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -32,6 +34,7 @@ import java.time.LocalDateTime; * @date 2019/03/19 */ @Data +@ApiModel(value = "字典类型") @EqualsAndHashCode(callSuper = true) public class SysDict extends Model { private static final long serialVersionUID = 1L; @@ -40,40 +43,49 @@ public class SysDict extends Model { * 编号 */ @TableId + @ApiModelProperty(value = "字典编号") private Integer id; /** * 类型 */ + @ApiModelProperty(value = "字典类型") private String type; /** * 描述 */ + @ApiModelProperty(value = "字典描述") private String description; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; /** * 是否是系统内置 */ @TableField(value = "`system`") + @ApiModelProperty(value = "是否系统内置") private String system; /** * 备注信息 */ + @ApiModelProperty (value = "备注信息") private String remarks; /** * 删除标记 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; /** * 所属租户 */ + @ApiModelProperty(value = "所属租户") private Integer tenantId; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDictItem.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDictItem.java index 42ebb59b6..93d2dedf3 100755 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDictItem.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysDictItem.java @@ -18,8 +18,9 @@ package com.pig4cloud.pigx.admin.api.entity; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; -import com.baomidou.mybatisplus.annotation.TableName; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -32,59 +33,71 @@ import java.time.LocalDateTime; * @date 2019/03/19 */ @Data +@ApiModel(value = "字典项") @EqualsAndHashCode(callSuper = true) public class SysDictItem extends Model { private static final long serialVersionUID = 1L; - /** * 编号 */ @TableId + @ApiModelProperty(value = "字典项id") private Integer id; /** - * + * 所属字典类id */ + @ApiModelProperty(value = "所属字典类id") private Integer dictId; /** * 数据值 */ + @ApiModelProperty(value = "数据值") private String value; /** * 标签名 */ + @ApiModelProperty(value = "标签名") private String label; /** * 类型 */ + @ApiModelProperty(value = "类型") private String type; /** * 描述 */ + @ApiModelProperty(value = "描述") private String description; /** * 排序（升序） */ + @ApiModelProperty(value = "排序值，默认升序") private Integer sort; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; /** * 备注信息 */ + @ApiModelProperty(value = "备注信息") private String remarks; /** * 删除标记 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; /** * 所属租户 */ + @ApiModelProperty(value = "所属租户id") private Integer tenantId; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysFile.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysFile.java index 7c8cd8fae..9597c9513 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysFile.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysFile.java @@ -22,6 +22,7 @@ import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.extension.activerecord.Model; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -34,8 +35,8 @@ import java.time.LocalDateTime; * @date 2019-06-18 17:18:42 */ @Data +@ApiModel(value = "文件") @EqualsAndHashCode(callSuper = true) -@ApiModel(description = "文件管理") public class SysFile extends Model { private static final long serialVersionUID = 1L; @@ -43,46 +44,57 @@ public class SysFile extends Model { * 编号 */ @TableId(type = IdType.AUTO) + @ApiModelProperty(value = "文件编号") private Long id; /** * 文件名 */ + @ApiModelProperty(value = "文件名") private String fileName; /** * 原文件名 */ + @ApiModelProperty(value = "原始文件名") private String original; /** * 容器名称 */ + @ApiModelProperty(value = "存储桶名称") private String bucketName; /** * 文件类型 */ + @ApiModelProperty(value = "文件类型") private String type; /** * 文件大小 */ + @ApiModelProperty(value = "文件大小") private Long fileSize; /** * 上传人 */ + @ApiModelProperty(value = "创建者") private String createUser; /** * 上传时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新人 */ + @ApiModelProperty(value = "更新者") private String updateUser; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; /** * 删除标识：1-删除，0-正常 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private Integer delFlag; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysLog.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysLog.java index 85b605a41..c1f0c80ac 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysLog.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysLog.java @@ -22,6 +22,8 @@ package com.pig4cloud.pigx.admin.api.entity; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -37,6 +39,7 @@ import java.time.LocalDateTime; * @since 2017-11-20 */ @Data +@ApiModel(value = "日志") public class SysLog implements Serializable { private static final long serialVersionUID = 1L; @@ -44,69 +47,81 @@ public class SysLog implements Serializable { /** * 编号 */ - @TableId(value = "id", type = IdType.AUTO) + @TableId(type = IdType.AUTO) + @ApiModelProperty(value = "日志编号") private Long id; /** * 日志类型 */ @NotBlank(message = "日志类型不能为空") + @ApiModelProperty(value = "日志类型") private String type; /** * 日志标题 */ @NotBlank(message = "日志标题不能为空") + @ApiModelProperty(value = "日志标题") private String title; /** * 创建者 */ + @ApiModelProperty(value = "创建人") private String createBy; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; /** * 操作IP地址 */ + @ApiModelProperty(value = "操作ip地址") private String remoteAddr; /** * 用户代理 */ + @ApiModelProperty(value = "用户代理") private String userAgent; /** * 请求URI */ + @ApiModelProperty(value = "请求uri") private String requestUri; /** * 操作方式 */ + @ApiModelProperty(value = "操作方式") private String method; /** * 操作提交的数据 */ + @ApiModelProperty(value = "提交数据") private String params; /** * 执行时间 */ + @ApiModelProperty(value = "方法执行时间") private Long time; - /** * 异常信息 */ + @ApiModelProperty(value = "异常信息") private String exception; - /** * 服务ID */ + @ApiModelProperty(value = "应用标识") private String serviceId; - /** * 删除标记 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysMenu.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysMenu.java index 19836c775..bebafc7f9 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysMenu.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysMenu.java @@ -23,6 +23,8 @@ import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -39,64 +41,75 @@ import java.time.LocalDateTime; * @since 2017-11-08 */ @Data +@ApiModel(value = "菜单") @EqualsAndHashCode(callSuper = true) public class SysMenu extends Model { private static final long serialVersionUID = 1L; - /** * 菜单ID */ @TableId(value = "menu_id", type = IdType.AUTO) + @ApiModelProperty(value = "菜单id") private Integer menuId; /** * 菜单名称 */ @NotBlank(message = "菜单名称不能为空") + @ApiModelProperty(value = "菜单名称") private String name; /** * 菜单权限标识 */ + @ApiModelProperty(value = "菜单权限标识") private String permission; /** * 父菜单ID */ @NotNull(message = "菜单父ID不能为空") + @ApiModelProperty(value = "菜单父id") private Integer parentId; /** * 图标 */ + @ApiModelProperty(value = "菜单图标") private String icon; - /** * 前端路由标识路径，默认和 comment 保持一致 * 过期 */ + @ApiModelProperty(value = "前端路由标识路径") private String path; /** * 排序值 */ + @ApiModelProperty(value = "排序值") private Integer sort; /** * 菜单类型 （0菜单 1按钮） */ @NotNull(message = "菜单类型不能为空") + @ApiModelProperty(value = "菜单类型,0:菜单 1:按钮") private String type; /** * 路由缓冲 */ + @ApiModelProperty(value = "路由缓冲") private String keepAlive; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; /** * 0--正常 1--删除 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysOauthClientDetails.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysOauthClientDetails.java index 246968747..7f7e455dd 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysOauthClientDetails.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysOauthClientDetails.java @@ -22,6 +22,8 @@ package com.pig4cloud.pigx.admin.api.entity; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -37,67 +39,68 @@ import java.io.Serializable; * @since 2018-05-15 */ @Data +@ApiModel(value = "客户端信息") @EqualsAndHashCode(callSuper = true) public class SysOauthClientDetails extends Model { private static final long serialVersionUID = 1L; - /** * 客户端ID */ @NotBlank(message = "client_id 不能为空") @TableId(value = "client_id", type = IdType.INPUT) + @ApiModelProperty(value = "客户端id") private String clientId; - /** * 客户端密钥 */ @NotBlank(message = "client_secret 不能为空") + @ApiModelProperty(value = "客户端密钥") private String clientSecret; - /** * 资源ID */ + @ApiModelProperty(value = "资源id列表") private String resourceIds; - /** * 作用域 */ @NotBlank(message = "scope 不能为空") + @ApiModelProperty(value = "作用域") private String scope; - /** * 授权方式（A,B,C） */ + @ApiModelProperty(value = "授权方式") private String authorizedGrantTypes; - + /** + * 回调地址 + */ + @ApiModelProperty(value = "回调地址") private String webServerRedirectUri; - + /** + * 权限 + */ + @ApiModelProperty(value = "权限列表") private String authorities; - /** * 请求令牌有效时间 */ + @ApiModelProperty(value = "请求令牌有效时间") private Integer accessTokenValidity; - /** * 刷新令牌有效时间 */ + @ApiModelProperty(value = "刷新令牌有效时间") private Integer refreshTokenValidity; - /** * 扩展信息 */ + @ApiModelProperty(value = "扩展信息") private String additionalInformation; - /** * 是否自动放行 */ + @ApiModelProperty(value = "是否自动放行") private String autoapprove; - - @Override - protected Serializable pkVal() { - return this.clientId; - } - } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysPublicParam.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysPublicParam.java index 73b7075ea..02e0d2c16 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysPublicParam.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysPublicParam.java @@ -37,83 +37,67 @@ import java.util.Date; * @date 2019-04-29 */ @Data +@ApiModel(value = "公共参数") @EqualsAndHashCode(callSuper = true) -@ApiModel(description = "公共参数") public class SysPublicParam extends Model { private static final long serialVersionUID = 1L; - /** * 编号 */ @TableId + @ApiModelProperty(value = "公共参数编号") private Long publicId; - /** * 公共参数名称 */ @ApiModelProperty(value = "公共参数名称", required = true, example = "公共参数名称") private String publicName; - /** * 公共参数地址值,英文大写+下划线 */ @ApiModelProperty(value = "键[英文大写+下划线]", required = true, example = "PIGX_PUBLIC_KEY") private String publicKey; - /** * 值 */ @ApiModelProperty(value = "值", required = true, example = "999") private String publicValue; - /** * 状态（1有效；2无效；） */ @ApiModelProperty(value = "标识[1有效；2无效]", example = "1") private String status; - /** * 删除状态（0：正常 1：已删除） */ @TableLogic @ApiModelProperty(value = "状态[0-正常，1-删除]", example = "0") private String delFlag; - /** * 公共参数编码 */ @ApiModelProperty(value = "编码", example = "^(PIG|PIGX)$") private String validateCode; - /** * 创建时间 */ @ApiModelProperty(value = "创建时间", example = "2019-03-21 12:28:48") - @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") - @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") private Date createTime; - /** * 修改时间 */ @ApiModelProperty(value = "修改时间", example = "2019-03-21 12:28:48") - @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") - @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") private Date updateTime; - /** * 是否是系统内置 */ - @ApiModelProperty(value = "是否是系统内置") @TableField(value = "`system`") + @ApiModelProperty(value = "是否是系统内置") private String system; - - /** * 配置类型：0-默认；1-检索；2-原文；3-报表；4-安全；5-文档；6-消息；9-其他 */ @ApiModelProperty(value = "类型[1-检索；2-原文...]", example = "1") private String publicType; - } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRole.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRole.java index 1947e35ce..cdadcc683 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRole.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRole.java @@ -23,6 +23,8 @@ import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -40,39 +42,51 @@ import java.time.LocalDateTime; * @since 2017-10-29 */ @Data +@ApiModel(value = "角色") @EqualsAndHashCode(callSuper = true) public class SysRole extends Model { private static final long serialVersionUID = 1L; @TableId(value = "role_id", type = IdType.AUTO) + @ApiModelProperty(value = "角色编号") private Integer roleId; - @NotBlank(message = "角色名称 不能为空") + @NotBlank(message = "角色名称不能为空") + @ApiModelProperty(value = "角色名称") private String roleName; - @NotBlank(message = "角色标识 不能为空") + @NotBlank(message = "角色标识不能为空") + @ApiModelProperty(value = "角色标识") private String roleCode; - @NotBlank(message = "角色描述 不能为空") + @NotBlank(message = "角色描述不能为空") + @ApiModelProperty(value = "角色描述") private String roleDesc; - @NotNull(message = "数据权限类型 不能为空") + @NotNull(message = "数据权限类型不能为空") + @ApiModelProperty(value = "数据权限类型") private Integer dsType; - + /** + * 数据权限作用范围 + */ + @ApiModelProperty(value = "数据权限作用范围") private String dsScope; - + /** + * 创建时间 + */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; + /** + * 修改时间 + */ + @ApiModelProperty(value = "修改时间") private LocalDateTime updateTime; /** * 删除标识（0-正常,1-删除） */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; - @Override - protected Serializable pkVal() { - return this.roleId; - } - } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRoleMenu.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRoleMenu.java index a6d977fc2..7e4c058a8 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRoleMenu.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRoleMenu.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.entity; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -32,17 +34,19 @@ import lombok.EqualsAndHashCode; * @since 2017-10-29 */ @Data +@ApiModel(value = "角色菜单") @EqualsAndHashCode(callSuper = true) public class SysRoleMenu extends Model { private static final long serialVersionUID = 1L; - /** * 角色ID */ + @ApiModelProperty(value = "角色id") private Integer roleId; /** * 菜单ID */ + @ApiModelProperty(value = "菜单id") private Integer menuId; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRouteConf.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRouteConf.java index 8cd501efe..0583648a5 100755 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRouteConf.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysRouteConf.java @@ -23,6 +23,8 @@ import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.extension.activerecord.Model; import com.fasterxml.jackson.annotation.JsonIgnore; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -35,49 +37,60 @@ import java.time.LocalDateTime; * @date 2018-11-06 10:17:18 */ @Data +@ApiModel(value = "网关路由信息") @EqualsAndHashCode(callSuper = true) public class SysRouteConf extends Model { private static final long serialVersionUID = 1L; @JsonIgnore @TableId(type = IdType.AUTO) + @ApiModelProperty(value = "主键") private Integer id; /** * 路由ID */ + @ApiModelProperty(value = "路由id") private String routeId; /** * 路由名称 */ + @ApiModelProperty(value = "路由名称") private String routeName; /** * 断言 */ + @ApiModelProperty(value = "断言") private String predicates; /** * 过滤器 */ + @ApiModelProperty(value = "过滤器") private String filters; /** * uri */ + @ApiModelProperty(value = "请求uri") private String uri; /** * 排序 */ @TableField(value = "`order`") + @ApiModelProperty(value = "排序值") private Integer order; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 修改时间 */ + @ApiModelProperty(value = "修改时间") private LocalDateTime updateTime; /** * 删除标识（0-正常,1-删除） */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysSocialDetails.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysSocialDetails.java index fc8c355d9..6e11a125b 100755 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysSocialDetails.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysSocialDetails.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.entity; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -33,6 +35,7 @@ import java.time.LocalDateTime; * @date 2018-08-16 21:30:41 */ @Data +@ApiModel(value = "第三方账号信息") @EqualsAndHashCode(callSuper = true) public class SysSocialDetails extends Model { private static final long serialVersionUID = 1L; @@ -41,47 +44,56 @@ public class SysSocialDetails extends Model { * 主鍵 */ @TableId + @ApiModelProperty(value = "主键") private Integer id; /** * 类型 */ @NotBlank(message = "类型不能为空") + @ApiModelProperty(value = "账号类型") private String type; /** * 描述 */ + @ApiModelProperty(value = "描述") private String remark; /** * appid */ @NotBlank(message = "账号不能为空") + @ApiModelProperty(value = "appId") private String appId; /** * app_secret */ @NotBlank(message = "密钥不能为空") + @ApiModelProperty(value = "app secret") private String appSecret; /** * 回调地址 */ + @ApiModelProperty(value = "回调地址") private String redirectUrl; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; /** * 删除标记 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; - /** * 租户ID */ + @ApiModelProperty(value = "所属租户") private Integer tenantId; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysTenant.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysTenant.java index 6ba45ce7c..9bf4d7e07 100755 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysTenant.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysTenant.java @@ -22,6 +22,7 @@ import com.baomidou.mybatisplus.annotation.TableLogic; import com.baomidou.mybatisplus.annotation.TableName; import com.baomidou.mybatisplus.extension.activerecord.Model; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -35,49 +36,56 @@ import java.time.LocalDateTime; * @date 2019-05-15 15:55:41 */ @Data -@TableName("sys_tenant") +@ApiModel(value = "租户信息") @EqualsAndHashCode(callSuper = true) -@ApiModel(description = "租户") public class SysTenant extends Model { private static final long serialVersionUID = 1L; - /** * 租户id */ @TableId + @ApiModelProperty(value = "租户id") private Integer id; /** * 租户名称 */ + @ApiModelProperty(value = "租户名称") private String name; /** * 租户编号 */ + @ApiModelProperty(value = "租户编号") private String code; /** * 开始时间 */ + @ApiModelProperty(value = "开始时间") private LocalDate startTime; /** * 结束时间 */ + @ApiModelProperty(value = "结束时间") private LocalDate endTime; /** * 0正常 9-冻结 */ + @ApiModelProperty(value = "租户冻结标记,9:冻结,0:正常") private String status; /** * 删除标记 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; /** - * 创建 + * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUser.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUser.java index c4dcbbd60..c59513625 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUser.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUser.java @@ -23,6 +23,8 @@ import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableLogic; import com.fasterxml.jackson.annotation.JsonIgnore; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -37,6 +39,7 @@ import java.time.LocalDateTime; * @since 2017-10-29 */ @Data +@ApiModel(value = "用户") public class SysUser implements Serializable { private static final long serialVersionUID = 1L; @@ -45,73 +48,83 @@ public class SysUser implements Serializable { * 主键ID */ @TableId(value = "user_id", type = IdType.AUTO) + @ApiModelProperty(value = "主键id") private Integer userId; /** * 用户名 */ + @ApiModelProperty(value = "用户名") private String username; - + /** + * 密码 + */ + @ApiModelProperty(value = "密码") private String password; /** * 随机盐 */ @JsonIgnore + @ApiModelProperty(value = "随机盐") private String salt; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 修改时间 */ + @ApiModelProperty(value = "修改时间") private LocalDateTime updateTime; /** * 0-正常，1-删除 */ @TableLogic + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; - /** * 锁定标记 */ + @ApiModelProperty(value = "锁定标记") private String lockFlag; - /** - * 简介 + * 手机号 */ + @ApiModelProperty(value = "手机号") private String phone; /** * 头像 */ + @ApiModelProperty(value = "头像地址") private String avatar; - /** * 部门ID */ + @ApiModelProperty(value = "用户所属部门id") private Integer deptId; - /** * 租户ID */ + @ApiModelProperty(value = "用户所属租户id") private Integer tenantId; - /** * 微信openid */ + @ApiModelProperty(value = "微信openid") private String wxOpenid; - /** * QQ openid */ + @ApiModelProperty(value = "QQ openid") private String qqOpenid; - /** * 码云唯一标识 */ + @ApiModelProperty(value = "码云唯一标识") private String giteeLogin; - /** * 开源中国唯一标识 */ + @ApiModelProperty(value = "开源中国唯一标识") private String oscId; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUserRole.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUserRole.java index 059b53297..47322e372 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUserRole.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/entity/SysUserRole.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.entity; import com.baomidou.mybatisplus.extension.activerecord.Model; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -32,18 +34,20 @@ import lombok.EqualsAndHashCode; * @since 2017-10-29 */ @Data +@ApiModel(value = "用户角色") @EqualsAndHashCode(callSuper = true) public class SysUserRole extends Model { private static final long serialVersionUID = 1L; - /** * 用户ID */ + @ApiModelProperty(value = "用户id") private Integer userId; /** * 角色ID */ + @ApiModelProperty(value = "角色id") private Integer roleId; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ImageCode.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ImageCode.java index 433057729..0c4bf192b 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ImageCode.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ImageCode.java @@ -19,6 +19,8 @@ package com.pig4cloud.pigx.admin.api.vo; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.awt.image.BufferedImage; @@ -27,15 +29,28 @@ import java.time.LocalDateTime; /** + * 图形验证码 + * * @author lengleng * @date 2017-12-18 */ @Data +@ApiModel(value = "图形验证码") public class ImageCode implements Serializable { + /** + * 随机数 + */ + @ApiModelProperty(value = "随机数") private String code; - + /** + * 验证码过期时间 + */ + @ApiModelProperty(value = "验证码过期时间") private LocalDateTime expireTime; - + /** + * 验证码图片 + */ + @ApiModelProperty(value = "验证码图片") private BufferedImage image; public ImageCode(BufferedImage image, String sRand, int defaultImageExpire) { diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/LogVO.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/LogVO.java index fa49802c2..3d9257835 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/LogVO.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/LogVO.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.vo; import com.pig4cloud.pigx.admin.api.entity.SysLog; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -29,9 +31,12 @@ import java.io.Serializable; * @date 2017/11/20 */ @Data +@ApiModel(value = "日志展示对象") public class LogVO implements Serializable { private static final long serialVersionUID = 1L; + @ApiModelProperty(value = "日志内容") private SysLog sysLog; + @ApiModelProperty(value = "产生日志的用户") private String username; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/MenuVO.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/MenuVO.java index dc8732829..bd4a268fe 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/MenuVO.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/MenuVO.java @@ -19,6 +19,8 @@ package com.pig4cloud.pigx.admin.api.vo; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -33,6 +35,7 @@ import java.time.LocalDateTime; * @since 2017-11-08 */ @Data +@ApiModel(value = "菜单展示对象") public class MenuVO implements Serializable { private static final long serialVersionUID = 1L; @@ -40,50 +43,62 @@ public class MenuVO implements Serializable { /** * 菜单ID */ + @ApiModelProperty(value = "菜单id") private Integer menuId; /** * 菜单名称 */ + @ApiModelProperty(value = "菜单名称") private String name; /** * 菜单权限标识 */ + @ApiModelProperty(value = "菜单权限标识") private String permission; /** * 父菜单ID */ + @ApiModelProperty(value = "父菜单id") private Integer parentId; /** * 图标 */ + @ApiModelProperty(value = "图标") private String icon; /** - * 一个路径 + * 前端路由标识路径 */ + @ApiModelProperty(value = "前端路由标识路径") private String path; /** * 排序值 */ + @ApiModelProperty(value = "排序值") private Integer sort; /** * 菜单类型 （0菜单 1按钮） */ + @ApiModelProperty(value = "菜单类型,0:菜单 1:按钮") private String type; /** * 是否缓冲 */ + @ApiModelProperty(value = "路由缓冲") private String keepAlive; /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 更新时间 */ + @ApiModelProperty(value = "更新时间") private LocalDateTime updateTime; /** * 0--正常 1--删除 */ + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ParamVo.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ParamVo.java index 800a8219f..ee536fe46 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ParamVo.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/ParamVo.java @@ -18,6 +18,8 @@ package com.pig4cloud.pigx.admin.api.vo; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -30,6 +32,7 @@ import java.io.Serializable; * 公共参数 */ @Data +@ApiModel(value = "公共参数展示对象") @EqualsAndHashCode(callSuper = false) @JsonIgnoreProperties(ignoreUnknown = true) public class ParamVo implements Serializable { @@ -38,13 +41,16 @@ public class ParamVo implements Serializable { /** * 公共参数键 */ + @ApiModelProperty(value = "公共参数键") private String publicKey; /** * 公共参数值 */ + @ApiModelProperty(value = "公共参数值") private String publicValue; /** * 公共参数名 */ + @ApiModelProperty(value = "公共参数名称") private String publicName; } \ No newline at end of file diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/PreLogVo.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/PreLogVo.java index c7bb2dfc9..e8773635d 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/PreLogVo.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/PreLogVo.java @@ -17,6 +17,8 @@ package com.pig4cloud.pigx.admin.api.vo; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; /** @@ -25,12 +27,41 @@ import lombok.Data; * 前端日志vo */ @Data +@ApiModel(value = "前端日志展示对象") public class PreLogVo { + /** + * 请求url + */ + @ApiModelProperty(value = "请求url") private String url; + /** + * 请求耗时 + */ + @ApiModelProperty(value = "请求耗时") private String time; + /** + * 请求用户 + */ + @ApiModelProperty(value = "请求用户") private String user; + /** + * 请求结果 + */ + @ApiModelProperty(value = "请求结果0:成功9:失败") private String type; + /** + * 请求传递参数 + */ + @ApiModelProperty(value = "请求传递参数") private String message; + /** + * 异常信息 + */ + @ApiModelProperty(value = "异常信息") private String stack; + /** + * 日志标题 + */ + @ApiModelProperty(value = "日志标题") private String info; } diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/UserVO.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/UserVO.java index 777dda2b9..3a3f30b78 100644 --- a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/UserVO.java +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/vo/UserVO.java @@ -20,6 +20,8 @@ package com.pig4cloud.pigx.admin.api.vo; import com.pig4cloud.pigx.admin.api.entity.SysRole; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -31,79 +33,88 @@ import java.util.List; * @date 2017/10/29 */ @Data +@ApiModel(value = "前端用户展示对象") public class UserVO implements Serializable { private static final long serialVersionUID = 1L; /** * 主键ID */ + @ApiModelProperty(value = "主键") private Integer userId; /** * 用户名 */ + @ApiModelProperty(value = "用户名") private String username; /** * 密码 */ + @ApiModelProperty(value = "密码") private String password; /** * 随机盐 */ + @ApiModelProperty(value = "随机盐") private String salt; - /** * 微信openid */ + @ApiModelProperty(value = "微信open id") private String wxOpenid; - /** * QQ openid */ + @ApiModelProperty(value = "qq open id") private String qqOpenid; - /** * 创建时间 */ + @ApiModelProperty(value = "创建时间") private LocalDateTime createTime; /** * 修改时间 */ + @ApiModelProperty(value = "修改时间") private LocalDateTime updateTime; /** * 0-正常，1-删除 */ + @ApiModelProperty(value = "删除标记,1:已删除,0:正常") private String delFlag; - /** * 锁定标记 */ + @ApiModelProperty(value = "锁定标记,0:正常,9:已锁定") private String lockFlag; /** - * 简介 + * 手机号 */ + @ApiModelProperty(value = "手机号") private String phone; /** * 头像 */ + @ApiModelProperty(value = "头像") private String avatar; - /** * 部门ID */ + @ApiModelProperty(value = "所属部门") private Integer deptId; - /** * 租户ID */ + @ApiModelProperty(value = "所属租户") private Integer tenantId; - /** * 部门名称 */ + @ApiModelProperty(value = "所属部门名称") private String deptName; - /** * 角色列表 */ + @ApiModelProperty(value = "拥有的角色列表") private List roleList; } From 9235f30c81bbc953137863cc7a77c76ebae6972f Mon Sep 17 00:00:00 2001 From: lishangbu Date: Wed, 3 Jul 2019 17:40:00 +0800 Subject: [PATCH 2/2] =?UTF-8?q?:sparkles:=20Introducing=20new=20features.?= =?UTF-8?q?=E6=B7=BB=E5=8A=A0Excel=E5=AF=BC=E5=87=BA=E6=A1=88=E4=BE=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pigx-common/pigx-common-bom/pom.xml | 5 ++ pigx-upms/pigx-upms-api/pom.xml | 6 ++ .../api/excel/SysPublicParamRowModel.java | 90 +++++++++++++++++++ pigx-upms/pigx-upms-biz/pom.xml | 5 ++ .../controller/SysPublicParamController.java | 28 ++++++ 5 files changed, 134 insertions(+) create mode 100644 pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/excel/SysPublicParamRowModel.java diff --git a/pigx-common/pigx-common-bom/pom.xml b/pigx-common/pigx-common-bom/pom.xml index 5f7cca2ef..6d99572c5 100644 --- a/pigx-common/pigx-common-bom/pom.xml +++ b/pigx-common/pigx-common-bom/pom.xml @@ -62,6 +62,11 @@ pigx-common-minio ${pigx.version} + + com.pig4cloud + pigx-common-excel + ${pigx.version} + com.pig4cloud pigx-common-security diff --git a/pigx-upms/pigx-upms-api/pom.xml b/pigx-upms/pigx-upms-api/pom.xml index e942e30a3..9950af05a 100644 --- a/pigx-upms/pigx-upms-api/pom.xml +++ b/pigx-upms/pigx-upms-api/pom.xml @@ -44,5 +44,11 @@ com.baomidou mybatis-plus-extension + + + com.pig4cloud + pigx-common-excel + true + diff --git a/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/excel/SysPublicParamRowModel.java b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/excel/SysPublicParamRowModel.java new file mode 100644 index 000000000..512d981d9 --- /dev/null +++ b/pigx-upms/pigx-upms-api/src/main/java/com/pig4cloud/pigx/admin/api/excel/SysPublicParamRowModel.java @@ -0,0 +1,90 @@ +package com.pig4cloud.pigx.admin.api.excel; + +import com.alibaba.excel.annotation.ExcelProperty; +import com.alibaba.excel.metadata.BaseRowModel; +import com.baomidou.mybatisplus.annotation.TableLogic; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.Data; +import lombok.EqualsAndHashCode; + +import java.util.Date; + +/** + * 公共参数Excel导出实体 + * + * @author lishangbu + * @date 2019-07-03 + */ +@Data +@ApiModel(value = "公共参数Excel导出实体") +@EqualsAndHashCode(callSuper = true) +public class SysPublicParamRowModel extends BaseRowModel { + private static final long serialVersionUID = 1L; + /** + * 编号 + */ + @ExcelProperty(index = 0 ,value = "公共参数编号") + @ApiModelProperty(value = "公共参数编号") + private Long publicId; + /** + * 公共参数名称 + */ + @ExcelProperty(index = 1 ,value = "公共参数名称") + @ApiModelProperty(value = "公共参数名称", required = true, example = "公共参数名称") + private String publicName; + /** + * 公共参数地址值,英文大写+下划线 + */ + @ExcelProperty(index = 2,value = "公共参数地址") + @ApiModelProperty(value = "键[英文大写+下划线]", required = true, example = "PIGX_PUBLIC_KEY") + private String publicKey; + /** + * 值 + */ + @ExcelProperty(index = 3,value = "值") + @ApiModelProperty(value = "值", required = true, example = "999") + private String publicValue; + /** + * 状态（1有效；2无效；） + */ + @ExcelProperty(index = 4,value = "状态") + @ApiModelProperty(value = "标识[1有效；2无效]", example = "1") + private String status; + /** + * 删除状态（0：正常 1：已删除） + */ + @ExcelProperty(index = 5,value = "删除状态") + @ApiModelProperty(value = "状态[0-正常，1-删除]", example = "0") + private String delFlag; + /** + * 公共参数编码 + */ + @ExcelProperty(index = 6,value = "公共参数编码") + @ApiModelProperty(value = "编码", example = "^(PIG|PIGX)$") + private String validateCode; + /** + * 创建时间 + */ + @ExcelProperty(index = 7,value = "创建时间") + @ApiModelProperty(value = "创建时间", example = "2019-03-21 12:28:48") + private Date createTime; + /** + * 修改时间 + */ + @ExcelProperty(index = 8,value = "修改时间") + @ApiModelProperty(value = "修改时间", example = "2019-03-21 12:28:48") + private Date updateTime; + /** + * 是否是系统内置 + */ + @ExcelProperty(index = 9,value = "系统内置标识") + @ApiModelProperty(value = "是否是系统内置") + private String system; + /** + * 配置类型：0-默认；1-检索；2-原文；3-报表；4-安全；5-文档；6-消息；9-其他 + */ + @ExcelProperty(index = 10,value = "配置类型") + @ApiModelProperty(value = "类型[1-检索；2-原文...]", example = "1") + private String publicType; +} diff --git a/pigx-upms/pigx-upms-biz/pom.xml b/pigx-upms/pigx-upms-biz/pom.xml index 973e768ef..f85715089 100644 --- a/pigx-upms/pigx-upms-biz/pom.xml +++ b/pigx-upms/pigx-upms-biz/pom.xml @@ -57,6 +57,11 @@ com.pig4cloud pigx-common-minio + + + com.pig4cloud + pigx-common-excel + org.springframework.cloud diff --git a/pigx-upms/pigx-upms-biz/src/main/java/com/pig4cloud/pigx/admin/controller/SysPublicParamController.java b/pigx-upms/pigx-upms-biz/src/main/java/com/pig4cloud/pigx/admin/controller/SysPublicParamController.java index 5e6b8dcb5..6cdc5991e 100644 --- a/pigx-upms/pigx-upms-biz/src/main/java/com/pig4cloud/pigx/admin/controller/SysPublicParamController.java +++ b/pigx-upms/pigx-upms-biz/src/main/java/com/pig4cloud/pigx/admin/controller/SysPublicParamController.java @@ -19,7 +19,9 @@ package com.pig4cloud.pigx.admin.controller; import com.baomidou.mybatisplus.core.toolkit.Wrappers; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; +import com.pig4cloud.common.excel.util.ExcelUtils; import com.pig4cloud.pigx.admin.api.entity.SysPublicParam; +import com.pig4cloud.pigx.admin.api.excel.SysPublicParamRowModel; import com.pig4cloud.pigx.admin.service.SysPublicParamService; import com.pig4cloud.pigx.common.core.util.R; import com.pig4cloud.pigx.common.log.annotation.SysLog; @@ -27,9 +29,14 @@ import com.pig4cloud.pigx.common.security.annotation.Inner; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import lombok.AllArgsConstructor; +import org.springframework.beans.BeanUtils; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; +import javax.servlet.http.HttpServletResponse; +import java.util.ArrayList; +import java.util.List; + /** * 公共参数 @@ -125,4 +132,25 @@ public class SysPublicParamController { public R removeById(@PathVariable Long publicId) { return sysPublicParamService.removeParam(publicId); } + + /** + * 导出Excel + * + * @param response + * @param sysPublicParam + * @return + */ + @ApiOperation("导出公共参数信息Excel") + @GetMapping("/export") + public void exportCustomerData(HttpServletResponse response, SysPublicParam sysPublicParam) { + List resultList = new ArrayList<>(); + List sysPublicParamList = sysPublicParamService.list(Wrappers.query(sysPublicParam)); + sysPublicParamList.forEach(data -> { + SysPublicParamRowModel publicParamRowModel = new SysPublicParamRowModel(); + BeanUtils.copyProperties(data, publicParamRowModel); + resultList.add(publicParamRowModel); + }); + ExcelUtils.writeExcel(response, resultList,"公共参数导出",SysPublicParamRowModel.class); + } + }