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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-common/src/main/java/com/ruoyi/common/core/page/TableDataInfo.java

@@ -1,10 +1,9 @@
package com.ruoyi.common.core.page;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import cn.hutool.http.HttpStatus;
import com.baomidou.mybatisplus.core.metadata.IPage;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

import java.io.Serializable;
import java.util.List;
@@ -17,44 +16,63 @@

@Data
@NoArgsConstructor
@Accessors(chain = true)
@ApiModel("分页响应对象")
public class TableDataInfo<T> implements Serializable {
   private static final long serialVersionUID = 1L;
    private static final long serialVersionUID = 1L;

   /**
    * 总记录数
    */
   @ApiModelProperty("总记录数")
   private long total;
    /**
     * 总记录数
     */
    private long total;

   /**
    * 列表数据
    */
   @ApiModelProperty("列表数据")
   private List<T> rows;
    /**
     * 列表数据
     */
    private List<T> rows;

   /**
    * 消息状态码
    */
   @ApiModelProperty("消息状态码")
   private int code;
    /**
     * 消息状态码
     */
    private int code;

   /**
    * 消息内容
    */
   @ApiModelProperty("消息内容")
   private String msg;
    /**
     * 消息内容
     */
    private String msg;

   /**
    * 分页
    *
    * @param list  列表数据
    * @param total 总记录数
    */
   public TableDataInfo(List<T> list, long total) {
      this.rows = list;
      this.total = total;
   }
    /**
     * 分页
     *
     * @param list  列表数据
     * @param total 总记录数
     */
    public TableDataInfo(List<T> list, long total) {
        this.rows = list;
        this.total = total;
    }

    public static <T> TableDataInfo<T> build(IPage<T> page) {
        TableDataInfo<T> rspData = new TableDataInfo<>();
        rspData.setCode(HttpStatus.HTTP_OK);
        rspData.setMsg("查询成功");
        rspData.setRows(page.getRecords());
        rspData.setTotal(page.getTotal());
        return rspData;
    }

    public static <T> TableDataInfo<T> build(List<T> list) {
        TableDataInfo<T> rspData = new TableDataInfo<>();
        rspData.setCode(HttpStatus.HTTP_OK);
        rspData.setMsg("查询成功");
        rspData.setRows(list);
        rspData.setTotal(list.size());
        return rspData;
    }

    public static <T> TableDataInfo<T> build() {
        TableDataInfo<T> rspData = new TableDataInfo<>();
        rspData.setCode(HttpStatus.HTTP_OK);
        rspData.setMsg("查询成功");
        return rspData;
    }

}