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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-system/src/main/java/com/ruoyi/system/domain/SysOperLog.java

@@ -7,7 +7,6 @@
import com.baomidou.mybatisplus.annotation.TableName;
import com.ruoyi.common.annotation.ExcelDictFormat;
import com.ruoyi.common.convert.ExcelDictConvert;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

import java.io.Serializable;
@@ -24,7 +23,6 @@
@Data
@TableName("sys_oper_log")
@ExcelIgnoreUnannotated
@Schema(name = "操作日志记录业务对象")
public class SysOperLog implements Serializable {

    private static final long serialVersionUID = 1L;
@@ -32,7 +30,6 @@
    /**
     * 日志主键
     */
    @Schema(name = "日志主键")
    @ExcelProperty(value = "日志主键")
    @TableId(value = "oper_id")
    private Long operId;
@@ -40,14 +37,12 @@
    /**
     * 操作模块
     */
    @Schema(name = "操作模块")
    @ExcelProperty(value = "操作模块")
    private String title;

    /**
     * 业务类型（0其它 1新增 2修改 3删除）
     */
    @Schema(name = "业务类型（0其它 1新增 2修改 3删除）")
    @ExcelProperty(value = "业务类型", converter = ExcelDictConvert.class)
    @ExcelDictFormat(dictType = "sys_oper_type")
    private Integer businessType;
@@ -55,28 +50,24 @@
    /**
     * 业务类型数组
     */
    @Schema(name = "业务类型数组")
    @TableField(exist = false)
    private Integer[] businessTypes;

    /**
     * 请求方法
     */
    @Schema(name = "请求方法")
    @ExcelProperty(value = "请求方法")
    private String method;

    /**
     * 请求方式
     */
    @Schema(name = "请求方式")
    @ExcelProperty(value = "请求方式")
    private String requestMethod;

    /**
     * 操作类别（0其它 1后台用户 2手机端用户）
     */
    @Schema(name = "操作类别（0其它 1后台用户 2手机端用户）")
    @ExcelProperty(value = "操作类别", converter = ExcelDictConvert.class)
    @ExcelDictFormat(readConverterExp = "0=其它,1=后台用户,2=手机端用户")
    private Integer operatorType;
@@ -84,56 +75,48 @@
    /**
     * 操作人员
     */
    @Schema(name = "操作人员")
    @ExcelProperty(value = "操作人员")
    private String operName;

    /**
     * 部门名称
     */
    @Schema(name = "部门名称")
    @ExcelProperty(value = "部门名称")
    private String deptName;

    /**
     * 请求url
     */
    @Schema(name = "请求url")
    @ExcelProperty(value = "请求地址")
    private String operUrl;

    /**
     * 操作地址
     */
    @Schema(name = "操作地址")
    @ExcelProperty(value = "操作地址")
    private String operIp;

    /**
     * 操作地点
     */
    @Schema(name = "操作地点")
    @ExcelProperty(value = "操作地点")
    private String operLocation;

    /**
     * 请求参数
     */
    @Schema(name = "请求参数")
    @ExcelProperty(value = "请求参数")
    private String operParam;

    /**
     * 返回参数
     */
    @Schema(name = "返回参数")
    @ExcelProperty(value = "返回参数")
    private String jsonResult;

    /**
     * 操作状态（0正常 1异常）
     */
    @Schema(name = "操作状态（0正常 1异常）")
    @ExcelProperty(value = "状态", converter = ExcelDictConvert.class)
    @ExcelDictFormat(dictType = "sys_common_status")
    private Integer status;
@@ -141,21 +124,18 @@
    /**
     * 错误消息
     */
    @Schema(name = "错误消息")
    @ExcelProperty(value = "错误消息")
    private String errorMsg;

    /**
     * 操作时间
     */
    @Schema(name = "操作时间")
    @ExcelProperty(value = "操作时间")
    private Date operTime;

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