update [重大更新]全业务 增加 接口文档注解 格式化代码

ruoyi-system/src/main/java/com/ruoyi/system/domain/vo/MetaVo.java

@@ -1,8 +1,9 @@
 package com.ruoyi.system.domain.vo;
 
 import com.ruoyi.common.utils.StringUtils;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
-import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 
 /**
@@ -12,28 +13,33 @@ import lombok.experimental.Accessors;
  */
 
 @Data
-@NoArgsConstructor
 @Accessors(chain = true)
+@ApiModel("路由显示信息")
 public class MetaVo {
+
     /**
      * 设置该路由在侧边栏和面包屑中展示的名字
      */
+    @ApiModelProperty(value = "设置该路由在侧边栏和面包屑中展示的名字")
     private String title;
 
     /**
      * 设置该路由的图标，对应路径src/assets/icons/svg
      */
+    @ApiModelProperty(value = "设置该路由的图标，对应路径src/assets/icons/svg")
     private String icon;
 
     /**
      * 设置为true，则不会被 <keep-alive>缓存
      */
+    @ApiModelProperty(value = "设置为true，则不会被 <keep-alive>缓存")
     private boolean noCache;
 
-	/**
-	 * 内链地址（http(s)://开头）
-	 */
-	private String link;
+    /**
+     * 内链地址（http(s)://开头）
+     */
+    @ApiModelProperty(value = "内链地址（http(s)://开头）")
+    private String link;
 
     public MetaVo(String title, String icon) {
         this.title = title;
@@ -46,19 +52,19 @@ public class MetaVo {
         this.noCache = noCache;
     }
 
-	public MetaVo(String title, String icon, String link) {
-		this.title = title;
-		this.icon = icon;
-		this.link = link;
-	}
+    public MetaVo(String title, String icon, String link) {
+        this.title = title;
+        this.icon = icon;
+        this.link = link;
+    }
 
-	public MetaVo(String title, String icon, boolean noCache, String link) {
-		this.title = title;
-		this.icon = icon;
-		this.noCache = noCache;
-		if (StringUtils.ishttp(link)) {
-			this.link = link;
-		}
-	}
+    public MetaVo(String title, String icon, boolean noCache, String link) {
+        this.title = title;
+        this.icon = icon;
+        this.noCache = noCache;
+        if (StringUtils.ishttp(link)) {
+            this.link = link;
+        }
+    }
 
 }

ruoyi-system/src/main/java/com/ruoyi/system/domain/vo/RouterVo.java

@@ -1,7 +1,9 @@
 package com.ruoyi.system.domain.vo;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import lombok.*;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
 import lombok.experimental.Accessors;
 
 import java.util.List;
@@ -9,56 +11,66 @@ import java.util.List;
 /**
  * 路由配置信息
  *
- * @author ruoyi
+ * @author Lion Li
  */
 @Data
-@NoArgsConstructor
 @Accessors(chain = true)
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
+@ApiModel("路由配置信息")
 public class RouterVo {
+
     /**
      * 路由名字
      */
+    @ApiModelProperty(value = "路由名字")
     private String name;
 
     /**
      * 路由地址
      */
+    @ApiModelProperty(value = "路由地址")
     private String path;
 
     /**
      * 是否隐藏路由，当设置 true 的时候该路由不会再侧边栏出现
      */
+    @ApiModelProperty(value = "是否隐藏路由，当设置 true 的时候该路由不会再侧边栏出现")
     private boolean hidden;
 
     /**
      * 重定向地址，当设置 noRedirect 的时候该路由在面包屑导航中不可被点击
      */
+    @ApiModelProperty(value = "重定向地址，当设置 noRedirect 的时候该路由在面包屑导航中不可被点击")
     private String redirect;
 
     /**
      * 组件地址
      */
+    @ApiModelProperty(value = "组件地址")
     private String component;
 
     /**
      * 路由参数：如 {"id": 1, "name": "ry"}
      */
+    @ApiModelProperty(value = "路由参数：如 {\"id\": 1, \"name\": \"ry\"}")
     private String query;
 
     /**
      * 当你一个路由下面的 children 声明的路由大于1个时，自动会变成嵌套的模式--如组件页面
      */
+    @ApiModelProperty(value = "当你一个路由下面的 children 声明的路由大于1个时，自动会变成嵌套的模式--如组件页面")
     private Boolean alwaysShow;
 
     /**
      * 其他元素
      */
+    @ApiModelProperty(value = "其他元素")
     private MetaVo meta;
 
     /**
      * 子路由
      */
+    @ApiModelProperty(value = "子路由")
     private List<RouterVo> children;
 
 }

ruoyi-system/src/main/java/com/ruoyi/system/domain/vo/SysOssConfigVo.java

@@ -6,7 +6,6 @@ import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 
-
 /**
  * 对象存储配置视图对象 sys_oss_config
  *
@@ -19,78 +18,78 @@ import lombok.Data;
 @ExcelIgnoreUnannotated
 public class SysOssConfigVo {
 
-	private static final long serialVersionUID = 1L;
+    private static final long serialVersionUID = 1L;
 
-	/**
+    /**
      * 主建
      */
-	@ApiModelProperty("主建")
-	private Long ossConfigId;
+    @ApiModelProperty("主建")
+    private Long ossConfigId;
 
     /**
      * 配置key
      */
-	@ApiModelProperty("配置key")
-	private String configKey;
+    @ApiModelProperty("配置key")
+    private String configKey;
 
     /**
      * accessKey
      */
-	@ApiModelProperty("accessKey")
-	private String accessKey;
+    @ApiModelProperty("accessKey")
+    private String accessKey;
 
     /**
      * 秘钥
      */
-	@ApiModelProperty("secretKey")
-	private String secretKey;
+    @ApiModelProperty("secretKey")
+    private String secretKey;
 
     /**
      * 桶名称
      */
-	@ApiModelProperty("桶名称")
-	private String bucketName;
+    @ApiModelProperty("桶名称")
+    private String bucketName;
 
     /**
      * 前缀
      */
-	@ApiModelProperty("前缀")
-	private String prefix;
+    @ApiModelProperty("前缀")
+    private String prefix;
 
     /**
      * 访问站点
      */
-	@ApiModelProperty("访问站点")
-	private String endpoint;
+    @ApiModelProperty("访问站点")
+    private String endpoint;
 
     /**
      * 是否https（Y=是,N=否）
      */
-	@ApiModelProperty("是否https（Y=是,N=否）")
-	private String isHttps;
+    @ApiModelProperty("是否https（Y=是,N=否）")
+    private String isHttps;
 
     /**
      * 域
      */
-	@ApiModelProperty("域")
-	private String region;
+    @ApiModelProperty("域")
+    private String region;
 
     /**
      * 状态（0=正常,1=停用）
      */
-	@ApiModelProperty("状态（0=正常,1=停用）")
-	private String status;
+    @ApiModelProperty("状态（0=正常,1=停用）")
+    private String status;
 
     /**
      * 扩展字段
      */
-	@ApiModelProperty("扩展字段")
-	private String ext1;
+    @ApiModelProperty("扩展字段")
+    private String ext1;
 
-	/**
-	 * 备注
-	 */
-	@ApiModelProperty("备注")
-	private String remark;
+    /**
+     * 备注
+     */
+    @ApiModelProperty("备注")
+    private String remark;
 
 }

ruoyi-system/src/main/java/com/ruoyi/system/domain/vo/SysOssVo.java

@@ -15,55 +15,55 @@ import java.util.Date;
 @ApiModel("OSS对象存储视图对象")
 public class SysOssVo {
 
-	private static final long serialVersionUID = 1L;
+    private static final long serialVersionUID = 1L;
 
-	/**
-	 *  对象存储主键
-	 */
-	@ApiModelProperty("对象存储主键")
-	private Long ossId;
+    /**
+     * 对象存储主键
+     */
+    @ApiModelProperty("对象存储主键")
+    private Long ossId;
 
-	/**
-	 * 文件名
-	 */
-	@ApiModelProperty("文件名")
-	private String fileName;
+    /**
+     * 文件名
+     */
+    @ApiModelProperty("文件名")
+    private String fileName;
 
-	/**
-	 * 原名
-	 */
-	@ApiModelProperty("原名")
-	private String originalName;
+    /**
+     * 原名
+     */
+    @ApiModelProperty("原名")
+    private String originalName;
 
-	/**
-	 * 文件后缀名
-	 */
-	@ApiModelProperty("文件后缀名")
-	private String fileSuffix;
+    /**
+     * 文件后缀名
+     */
+    @ApiModelProperty("文件后缀名")
+    private String fileSuffix;
 
-	/**
-	 * URL地址
-	 */
-	@ApiModelProperty("URL地址")
-	private String url;
+    /**
+     * URL地址
+     */
+    @ApiModelProperty("URL地址")
+    private String url;
 
-	/**
-	 * 创建时间
-	 */
-	@ApiModelProperty("创建时间")
-	private Date createTime;
+    /**
+     * 创建时间
+     */
+    @ApiModelProperty("创建时间")
+    private Date createTime;
 
-	/**
-	 * 上传人
-	 */
-	@ApiModelProperty("上传人")
-	private String createBy;
+    /**
+     * 上传人
+     */
+    @ApiModelProperty("上传人")
+    private String createBy;
 
-	/**
-	 * 服务商
-	 */
-	@ApiModelProperty("服务商")
-	private String service;
+    /**
+     * 服务商
+     */
+    @ApiModelProperty("服务商")
+    private String service;
 
 
 }

ruoyi-system/src/main/java/com/ruoyi/system/domain/vo/SysUserExportVo.java

@@ -20,74 +20,74 @@ import java.util.Date;
 @NoArgsConstructor
 @Accessors(chain = true)
 public class SysUserExportVo implements Serializable {
-	private static final long serialVersionUID = 1L;
+    private static final long serialVersionUID = 1L;
 
-	/**
-	 * 用户ID
-	 */
-	@ExcelProperty(value = "用户序号")
-	private Long userId;
+    /**
+     * 用户ID
+     */
+    @ExcelProperty(value = "用户序号")
+    private Long userId;
 
-	/**
-	 * 用户账号
-	 */
-	@ExcelProperty(value = "登录名称")
-	private String userName;
+    /**
+     * 用户账号
+     */
+    @ExcelProperty(value = "登录名称")
+    private String userName;
 
-	/**
-	 * 用户昵称
-	 */
-	@ExcelProperty(value = "用户名称")
-	private String nickName;
+    /**
+     * 用户昵称
+     */
+    @ExcelProperty(value = "用户名称")
+    private String nickName;
 
-	/**
-	 * 用户邮箱
-	 */
-	@ExcelProperty(value = "用户邮箱")
-	private String email;
+    /**
+     * 用户邮箱
+     */
+    @ExcelProperty(value = "用户邮箱")
+    private String email;
 
-	/**
-	 * 手机号码
-	 */
-	@ExcelProperty(value = "手机号码")
-	private String phonenumber;
+    /**
+     * 手机号码
+     */
+    @ExcelProperty(value = "手机号码")
+    private String phonenumber;
 
-	/**
-	 * 用户性别
-	 */
-	@ExcelProperty(value = "用户性别", converter = ExcelDictConvert.class)
-	@ExcelDictFormat(dictType = "sys_user_sex")
-	private String sex;
+    /**
+     * 用户性别
+     */
+    @ExcelProperty(value = "用户性别", converter = ExcelDictConvert.class)
+    @ExcelDictFormat(dictType = "sys_user_sex")
+    private String sex;
 
-	/**
-	 * 帐号状态（0正常 1停用）
-	 */
-	@ExcelProperty(value = "帐号状态", converter = ExcelDictConvert.class)
-	@ExcelDictFormat(dictType = "sys_common_status")
-	private String status;
+    /**
+     * 帐号状态（0正常 1停用）
+     */
+    @ExcelProperty(value = "帐号状态", converter = ExcelDictConvert.class)
+    @ExcelDictFormat(dictType = "sys_common_status")
+    private String status;
 
-	/**
-	 * 最后登录IP
-	 */
-	@ExcelProperty(value = "最后登录IP")
-	private String loginIp;
+    /**
+     * 最后登录IP
+     */
+    @ExcelProperty(value = "最后登录IP")
+    private String loginIp;
 
-	/**
-	 * 最后登录时间
-	 */
-	@ExcelProperty(value = "最后登录时间")
-	private Date loginDate;
+    /**
+     * 最后登录时间
+     */
+    @ExcelProperty(value = "最后登录时间")
+    private Date loginDate;
 
-	/**
-	 * 部门名称
-	 */
-	@ExcelProperty(value = "部门名称")
-	private String deptName;
+    /**
+     * 部门名称
+     */
+    @ExcelProperty(value = "部门名称")
+    private String deptName;
 
-	/**
-	 * 负责人
-	 */
-	@ExcelProperty(value = "部门负责人")
-	private String leader;
+    /**
+     * 负责人
+     */
+    @ExcelProperty(value = "部门负责人")
+    private String leader;
 
 }

ruoyi-system/src/main/java/com/ruoyi/system/domain/vo/SysUserImportVo.java

@@ -18,56 +18,56 @@ import java.io.Serializable;
 @NoArgsConstructor
 // @Accessors(chain = true) // 导入不允许使用 会找不到set方法
 public class SysUserImportVo implements Serializable {
-	private static final long serialVersionUID = 1L;
+    private static final long serialVersionUID = 1L;
 
-	/**
-	 * 用户ID
-	 */
-	@ExcelProperty(value = "用户序号")
-	private Long userId;
+    /**
+     * 用户ID
+     */
+    @ExcelProperty(value = "用户序号")
+    private Long userId;
 
-	/**
-	 * 部门ID
-	 */
-	@ExcelProperty(value = "部门编号")
-	private Long deptId;
+    /**
+     * 部门ID
+     */
+    @ExcelProperty(value = "部门编号")
+    private Long deptId;
 
-	/**
-	 * 用户账号
-	 */
-	@ExcelProperty(value = "登录名称")
-	private String userName;
+    /**
+     * 用户账号
+     */
+    @ExcelProperty(value = "登录名称")
+    private String userName;
 
-	/**
-	 * 用户昵称
-	 */
-	@ExcelProperty(value = "用户名称")
-	private String nickName;
+    /**
+     * 用户昵称
+     */
+    @ExcelProperty(value = "用户名称")
+    private String nickName;
 
-	/**
-	 * 用户邮箱
-	 */
-	@ExcelProperty(value = "用户邮箱")
-	private String email;
+    /**
+     * 用户邮箱
+     */
+    @ExcelProperty(value = "用户邮箱")
+    private String email;
 
-	/**
-	 * 手机号码
-	 */
-	@ExcelProperty(value = "手机号码")
-	private String phonenumber;
+    /**
+     * 手机号码
+     */
+    @ExcelProperty(value = "手机号码")
+    private String phonenumber;
 
-	/**
-	 * 用户性别
-	 */
-	@ExcelProperty(value = "用户性别", converter = ExcelDictConvert.class)
-	@ExcelDictFormat(dictType = "sys_user_sex")
-	private String sex;
+    /**
+     * 用户性别
+     */
+    @ExcelProperty(value = "用户性别", converter = ExcelDictConvert.class)
+    @ExcelDictFormat(dictType = "sys_user_sex")
+    private String sex;
 
-	/**
-	 * 帐号状态（0正常 1停用）
-	 */
-	@ExcelProperty(value = "帐号状态", converter = ExcelDictConvert.class)
-	@ExcelDictFormat(dictType = "sys_common_status")
-	private String status;
+    /**
+     * 帐号状态（0正常 1停用）
+     */
+    @ExcelProperty(value = "帐号状态", converter = ExcelDictConvert.class)
+    @ExcelDictFormat(dictType = "sys_common_status")
+    private String status;
 
 }