代码生成增加实体类文档注释

ruoyi-common/pom.xml

@@ -126,6 +126,13 @@
             <artifactId>javax.servlet-api</artifactId>
         </dependency>
 
+        <!-- knife4j swagger文档增强 -->
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-spring-boot-starter</artifactId>
+            <version>3.0.3</version>
+        </dependency>
+
         <!-- mybatis-plus 增强CRUD -->
         <dependency>
             <groupId>com.baomidou</groupId>
@@ -140,6 +147,7 @@
             <version>1.18.12</version>
         </dependency>
 
+        <!-- Java工具类库 -->
         <dependency>
             <groupId>cn.hutool</groupId>
             <artifactId>hutool-all</artifactId>

ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java

@@ -1,4 +1,4 @@
-package com.ruoyi.framework.config;
+package com.ruoyi.common.config;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -6,7 +6,6 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import com.ruoyi.common.config.RuoYiConfig;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.models.auth.In;
 import springfox.documentation.builders.ApiInfoBuilder;

ruoyi-framework/pom.xml

@@ -47,13 +47,6 @@
             </exclusions>
         </dependency>
 
-        <!-- knife4j -->
-        <dependency>
-            <groupId>com.github.xiaoymin</groupId>
-            <artifactId>knife4j-spring-boot-starter</artifactId>
-            <version>3.0.3</version>
-        </dependency>
-
         <!-- 获取系统信息 -->
         <dependency>
             <groupId>com.github.oshi</groupId>

ruoyi-generator/src/main/resources/vm/java/domain.java.vm

@@ -7,6 +7,8 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.ToString;
@@ -34,6 +36,7 @@ import com.ruoyi.common.core.domain.TreeEntity;
 @NoArgsConstructor
 @Accessors(chain = true)
 @TableName("${tableName}")
+@ApiModel(value = "${ClassName}", description = "${functionName}实体")
 public class ${ClassName} extends ${Entity}
 {
     private static final long serialVersionUID = 1L;
@@ -60,6 +63,7 @@ public class ${ClassName} extends ${Entity}
 #if($column.pk)
     @TableId(type= IdType.AUTO)
 #end
+    @ApiModelProperty("$column.columnComment")
     private $column.javaType $column.javaField;
 
 #end
@@ -67,6 +71,7 @@ public class ${ClassName} extends ${Entity}
 #if($table.sub)
     /** $table.subTable.functionName信息 */
     @TableField(exist = false)
+    @ApiModelProperty("$table.subTable.functionName列表")
     private List<${subClassName}> ${subclassName}List;
 #end
 }

ruoyi-generator/src/main/resources/vm/java/sub-domain.java.vm

@@ -6,12 +6,12 @@ import ${import};
 import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.ToString;
 import lombok.experimental.Accessors;
-import org.apache.commons.lang3.builder.ToStringBuilder;
-import org.apache.commons.lang3.builder.ToStringStyle;
 import com.ruoyi.common.annotation.Excel;
 import com.ruoyi.common.core.domain.BaseEntity;
 
@@ -26,6 +26,7 @@ import com.ruoyi.common.core.domain.BaseEntity;
 @NoArgsConstructor
 @Accessors(chain = true)
 @TableName("${subTableName}")
+@ApiModel(value = "${subClassName}", description = "${subTable.functionName}实体")
 public class ${subClassName} extends BaseEntity
 {
     private static final long serialVersionUID = 1L;
@@ -52,6 +53,7 @@ public class ${subClassName} extends BaseEntity
 #if($column.pk)
     @TableId(type= IdType.AUTO)
 #end
+    @ApiModelProperty("$column.columnComment")
     private $column.javaType $column.javaField;
 
 #end