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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysDictData.java

@@ -2,134 +2,99 @@

import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
import com.alibaba.excel.annotation.ExcelProperty;
import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.ruoyi.common.annotation.ExcelDictFormat;
import com.ruoyi.common.constant.UserConstants;
import com.ruoyi.common.convert.ExcelDictConvert;
import com.ruoyi.common.core.domain.BaseEntity;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import lombok.EqualsAndHashCode;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
import java.io.Serializable;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

/**
 * 字典数据表 sys_dict_data
 *
 * @author ruoyi
 * @author Lion Li
 */

@Data
@NoArgsConstructor
@Accessors(chain = true)
@EqualsAndHashCode(callSuper = true)
@TableName("sys_dict_data")
@ExcelIgnoreUnannotated
public class SysDictData implements Serializable {
   private static final long serialVersionUID = 1L;
public class SysDictData extends BaseEntity {

   /**
    * 字典编码
    */
   @ExcelProperty(value = "字典编码")
   @TableId(value = "dict_code", type = IdType.AUTO)
   private Long dictCode;
    /**
     * 字典编码
     */
    @ExcelProperty(value = "字典编码")
    @TableId(value = "dict_code")
    private Long dictCode;

   /**
    * 字典排序
    */
   @ExcelProperty(value = "字典排序")
   private Long dictSort;
    /**
     * 字典排序
     */
    @ExcelProperty(value = "字典排序")
    private Integer dictSort;

   /**
    * 字典标签
    */
   @ExcelProperty(value = "字典标签")
   @NotBlank(message = "字典标签不能为空")
   @Size(min = 0, max = 100, message = "字典标签长度不能超过100个字符")
   private String dictLabel;
    /**
     * 字典标签
     */
    @ExcelProperty(value = "字典标签")
    @NotBlank(message = "字典标签不能为空")
    @Size(min = 0, max = 100, message = "字典标签长度不能超过100个字符")
    private String dictLabel;

   /**
    * 字典键值
    */
   @ExcelProperty(value = "字典键值")
   @NotBlank(message = "字典键值不能为空")
   @Size(min = 0, max = 100, message = "字典键值长度不能超过100个字符")
   private String dictValue;
    /**
     * 字典键值
     */
    @ExcelProperty(value = "字典键值")
    @NotBlank(message = "字典键值不能为空")
    @Size(min = 0, max = 100, message = "字典键值长度不能超过100个字符")
    private String dictValue;

   /**
    * 字典类型
    */
   @ExcelProperty(value = "字典类型")
   @NotBlank(message = "字典类型不能为空")
   @Size(min = 0, max = 100, message = "字典类型长度不能超过100个字符")
   private String dictType;
    /**
     * 字典类型
     */
    @ExcelProperty(value = "字典类型")
    @NotBlank(message = "字典类型不能为空")
    @Size(min = 0, max = 100, message = "字典类型长度不能超过100个字符")
    private String dictType;

   /**
    * 样式属性（其他样式扩展）
    */
   @Size(min = 0, max = 100, message = "样式属性长度不能超过100个字符")
   private String cssClass;
    /**
     * 样式属性（其他样式扩展）
     */
    @Size(min = 0, max = 100, message = "样式属性长度不能超过100个字符")
    private String cssClass;

   /**
    * 表格字典样式
    */
   private String listClass;
    /**
     * 表格字典样式
     */
    private String listClass;

   /**
    * 是否默认（Y是 N否）
    */
   @ExcelProperty(value = "是否默认", converter = ExcelDictConvert.class)
   @ExcelDictFormat(dictType = "sys_yes_no")
   private String isDefault;
    /**
     * 是否默认（Y是 N否）
     */
    @ExcelProperty(value = "是否默认", converter = ExcelDictConvert.class)
    @ExcelDictFormat(dictType = "sys_yes_no")
    private String isDefault;

   /**
    * 状态（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_normal_disable")
    private String status;

   /**
    * 创建者
    */
   @TableField(fill = FieldFill.INSERT)
   private String createBy;
    /**
     * 备注
     */
    private String remark;

   /**
    * 创建时间
    */
   @TableField(fill = FieldFill.INSERT)
   private Date createTime;

   /**
    * 更新者
    */
   @TableField(fill = FieldFill.INSERT_UPDATE)
   private String updateBy;

   /**
    * 更新时间
    */
   @TableField(fill = FieldFill.INSERT_UPDATE)
   private Date updateTime;

   /**
    * 备注
    */
   private String remark;

   /**
    * 请求参数
    */
   @TableField(exist = false)
   private Map<String, Object> params = new HashMap<>();

   public boolean getDefault() {
      return UserConstants.YES.equals(this.isDefault) ? true : false;
   }
    public boolean getDefault() {
        return UserConstants.YES.equals(this.isDefault);
    }

}