xiaozhi/xiaozhi-admin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
疯狂的狮子li
2022-07-07 19:07:59 +08:00
parent 0b07780619
commit d9e54388e7
79 changed files with 26 additions and 548 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ruoyi-demo/src/main/java/com/ruoyi/demo/domain/bo/TestDemoBo.java
-8
View File
@@ -3,7 +3,6 @@ package com.ruoyi.demo.domain.bo;
import com.ruoyi.common.core.domain.BaseEntity;
import com.ruoyi.common.core.validate.AddGroup;
import com.ruoyi.common.core.validate.EditGroup;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@@ -19,48 +18,41 @@ import javax.validation.constraints.NotNull;
@Data
@EqualsAndHashCode(callSuper = true)
@Schema(name = "测试单表业务对象")
public class TestDemoBo extends BaseEntity {
/**
* 主键
*/
@Schema(name = "主键")
@NotNull(message = "主键不能为空", groups = {EditGroup.class})
private Long id;
/**
* 部门id
*/
@Schema(name = "部门id")
@NotNull(message = "部门id不能为空", groups = {AddGroup.class, EditGroup.class})
private Long deptId;
/**
* 用户id
*/
@Schema(name = "用户id")
@NotNull(message = "用户id不能为空", groups = {AddGroup.class, EditGroup.class})
private Long userId;
/**
* 排序号
*/
@Schema(name = "排序号")
@NotNull(message = "排序号不能为空", groups = {AddGroup.class, EditGroup.class})
private Integer orderNum;
/**
* key键
*/
@Schema(name = "key键")
@NotBlank(message = "key键不能为空", groups = {AddGroup.class, EditGroup.class})
private String testKey;
/**
* 值
*/
@Schema(name = "值")
@NotBlank(message = "值不能为空", groups = {AddGroup.class, EditGroup.class})
private String value;
ruoyi-demo/src/main/java/com/ruoyi/demo/domain/bo/TestDemoImportVo.java
-7
View File
@@ -1,7 +1,6 @@
package com.ruoyi.demo.domain.bo;
import com.alibaba.excel.annotation.ExcelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import javax.validation.constraints.NotBlank;
@@ -14,13 +13,11 @@ import javax.validation.constraints.NotNull;
* @date 2021-07-26
*/
@Data
@Schema(name = "测试单表业务对象")
public class TestDemoImportVo {
/**
* 部门id
*/
@Schema(name = "部门id")
@NotNull(message = "部门id不能为空")
@ExcelProperty(value = "部门id")
private Long deptId;
@@ -28,7 +25,6 @@ public class TestDemoImportVo {
/**
* 用户id
*/
@Schema(name = "用户id")
@NotNull(message = "用户id不能为空")
@ExcelProperty(value = "用户id")
private Long userId;
@@ -36,7 +32,6 @@ public class TestDemoImportVo {
/**
* 排序号
*/
@Schema(name = "排序号")
@NotNull(message = "排序号不能为空")
@ExcelProperty(value = "排序号")
private Long orderNum;
@@ -44,7 +39,6 @@ public class TestDemoImportVo {
/**
* key键
*/
@Schema(name = "key键")
@NotBlank(message = "key键不能为空")
@ExcelProperty(value = "key键")
private String testKey;
@@ -52,7 +46,6 @@ public class TestDemoImportVo {
/**
* 值
*/
@Schema(name = "值")
@NotBlank(message = "值不能为空")
@ExcelProperty(value = "值")
private String value;
ruoyi-demo/src/main/java/com/ruoyi/demo/domain/bo/TestTreeBo.java
-6
View File
@@ -3,7 +3,6 @@ package com.ruoyi.demo.domain.bo;
import com.ruoyi.common.core.domain.TreeEntity;
import com.ruoyi.common.core.validate.AddGroup;
import com.ruoyi.common.core.validate.EditGroup;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@@ -19,34 +18,29 @@ import javax.validation.constraints.NotNull;
@Data
@EqualsAndHashCode(callSuper = true)
@Schema(name = "测试树表业务对象")
public class TestTreeBo extends TreeEntity<TestTreeBo> {
/**
* 主键
*/
@Schema(name = "主键")
@NotNull(message = "主键不能为空", groups = {EditGroup.class})
private Long id;
/**
* 部门id
*/
@Schema(name = "部门id")
@NotNull(message = "部门id不能为空", groups = {AddGroup.class, EditGroup.class})
private Long deptId;
/**
* 用户id
*/
@Schema(name = "用户id")
@NotNull(message = "用户id不能为空", groups = {AddGroup.class, EditGroup.class})
private Long userId;
/**
* 树节点名
*/
@Schema(name = "树节点名")
@NotBlank(message = "树节点名不能为空", groups = {AddGroup.class, EditGroup.class})
private String treeName;
ruoyi-demo/src/main/java/com/ruoyi/demo/domain/vo/TestDemoVo.java
-12
View File
@@ -2,7 +2,6 @@ package com.ruoyi.demo.domain.vo;
import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
import com.alibaba.excel.annotation.ExcelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import java.util.Date;
@@ -15,7 +14,6 @@ import java.util.Date;
* @date 2021-07-26
*/
@Data
@Schema(name = "测试单表视图对象")
@ExcelIgnoreUnannotated
public class TestDemoVo {
@@ -25,70 +23,60 @@ public class TestDemoVo {
* 主键
*/
@ExcelProperty(value = "主键")
@Schema(name = "主键")
private Long id;
/**
* 部门id
*/
@ExcelProperty(value = "部门id")
@Schema(name = "部门id")
private Long deptId;
/**
* 用户id
*/
@ExcelProperty(value = "用户id")
@Schema(name = "用户id")
private Long userId;
/**
* 排序号
*/
@ExcelProperty(value = "排序号")
@Schema(name = "排序号")
private Integer orderNum;
/**
* key键
*/
@ExcelProperty(value = "key键")
@Schema(name = "key键")
private String testKey;
/**
* 值
*/
@ExcelProperty(value = "值")
@Schema(name = "值")
private String value;
/**
* 创建时间
*/
@ExcelProperty(value = "创建时间")
@Schema(name = "创建时间")
private Date createTime;
/**
* 创建人
*/
@ExcelProperty(value = "创建人")
@Schema(name = "创建人")
private String createBy;
/**
* 更新时间
*/
@ExcelProperty(value = "更新时间")
@Schema(name = "更新时间")
private Date updateTime;
/**
* 更新人
*/
@ExcelProperty(value = "更新人")
@Schema(name = "更新人")
private String updateBy;
ruoyi-demo/src/main/java/com/ruoyi/demo/domain/vo/TestTreeVo.java
-8
View File
@@ -2,7 +2,6 @@ package com.ruoyi.demo.domain.vo;
import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
import com.alibaba.excel.annotation.ExcelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import java.util.Date;
@@ -15,7 +14,6 @@ import java.util.Date;
* @date 2021-07-26
*/
@Data
@Schema(name = "测试树表视图对象")
@ExcelIgnoreUnannotated
public class TestTreeVo {
@@ -24,42 +22,36 @@ public class TestTreeVo {
/**
* 主键
*/
@Schema(name = "主键")
private Long id;
/**
* 父id
*/
@ExcelProperty(value = "父id")
@Schema(name = "父id")
private Long parentId;
/**
* 部门id
*/
@ExcelProperty(value = "部门id")
@Schema(name = "部门id")
private Long deptId;
/**
* 用户id
*/
@ExcelProperty(value = "用户id")
@Schema(name = "用户id")
private Long userId;
/**
* 树节点名
*/
@ExcelProperty(value = "树节点名")
@Schema(name = "树节点名")
private String treeName;
/**
* 创建时间
*/
@ExcelProperty(value = "创建时间")
@Schema(name = "创建时间")
private Date createTime;