add 整合 springdoc-openapi-javadoc 基于代码注释生成文档

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

@@ -1,7 +1,6 @@
 package com.ruoyi.system.domain.vo;
 
 import com.ruoyi.common.utils.StringUtils;
-import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 /**
@@ -11,31 +10,26 @@ import lombok.Data;
  */
 
 @Data
-@Schema(name = "路由显示信息")
 public class MetaVo {
 
     /**
      * 设置该路由在侧边栏和面包屑中展示的名字
      */
-    @Schema(name = "设置该路由在侧边栏和面包屑中展示的名字")
     private String title;
 
     /**
      * 设置该路由的图标，对应路径src/assets/icons/svg
      */
-    @Schema(name = "设置该路由的图标，对应路径src/assets/icons/svg")
     private String icon;
 
     /**
      * 设置为true，则不会被 <keep-alive>缓存
      */
-    @Schema(name = "设置为true，则不会被 <keep-alive>缓存")
     private boolean noCache;
 
     /**
      * 内链地址（http(s)://开头）
      */
-    @Schema(name = "内链地址（http(s)://开头）")
     private String link;
 
     public MetaVo(String title, String icon) {

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

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

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

@@ -1,7 +1,6 @@
 package com.ruoyi.system.domain.vo;
 
 import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
-import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 
@@ -13,7 +12,6 @@ import lombok.Data;
  * @date 2021-08-13
  */
 @Data
-@Schema(name = "对象存储配置视图对象")
 @ExcelIgnoreUnannotated
 public class SysOssConfigVo {
 
@@ -22,79 +20,66 @@ public class SysOssConfigVo {
     /**
      * 主建
      */
-    @Schema(name = "主建")
     private Long ossConfigId;
 
     /**
      * 配置key
      */
-    @Schema(name = "配置key")
     private String configKey;
 
     /**
      * accessKey
      */
-    @Schema(name = "accessKey")
     private String accessKey;
 
     /**
      * 秘钥
      */
-    @Schema(name = "secretKey")
     private String secretKey;
 
     /**
      * 桶名称
      */
-    @Schema(name = "桶名称")
     private String bucketName;
 
     /**
      * 前缀
      */
-    @Schema(name = "前缀")
     private String prefix;
 
     /**
      * 访问站点
      */
-    @Schema(name = "访问站点")
     private String endpoint;
 
     /**
      * 自定义域名
      */
-    @Schema(name = "自定义域名")
     private String domain;
 
     /**
      * 是否https（Y=是,N=否）
      */
-    @Schema(name = "是否https（Y=是,N=否）")
     private String isHttps;
 
     /**
      * 域
      */
-    @Schema(name = "域")
     private String region;
 
     /**
      * 状态（0=正常,1=停用）
      */
-    @Schema(name = "状态（0=正常,1=停用）")
     private String status;
 
     /**
      * 扩展字段
      */
-    @Schema(name = "扩展字段")
     private String ext1;
 
     /**
      * 备注
      */
-    @Schema(name = "备注")
     private String remark;
 
 }

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

@@ -1,6 +1,5 @@
 package com.ruoyi.system.domain.vo;
 
-import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.util.Date;
@@ -11,7 +10,6 @@ import java.util.Date;
  * @author Lion Li
  */
 @Data
-@Schema(name = "OSS对象存储视图对象")
 public class SysOssVo {
 
     private static final long serialVersionUID = 1L;
@@ -19,49 +17,41 @@ public class SysOssVo {
     /**
      * 对象存储主键
      */
-    @Schema(name = "对象存储主键")
     private Long ossId;
 
     /**
      * 文件名
      */
-    @Schema(name = "文件名")
     private String fileName;
 
     /**
      * 原名
      */
-    @Schema(name = "原名")
     private String originalName;
 
     /**
      * 文件后缀名
      */
-    @Schema(name = "文件后缀名")
     private String fileSuffix;
 
     /**
      * URL地址
      */
-    @Schema(name = "URL地址")
     private String url;
 
     /**
      * 创建时间
      */
-    @Schema(name = "创建时间")
     private Date createTime;
 
     /**
      * 上传人
      */
-    @Schema(name = "上传人")
     private String createBy;
 
     /**
      * 服务商
      */
-    @Schema(name = "服务商")
     private String service;