添加统一返回实体类和Bese基类的swaggers描述信息

master
面包骑士 2024-08-07 11:33:45 +08:00
parent 686f281510
commit 2a54a62a03
2 changed files with 44 additions and 0 deletions

View File

@ -2,6 +2,7 @@ package com.muyu.common.core.domain;
import com.muyu.common.core.constant.Constants; import com.muyu.common.core.constant.Constants;
import com.muyu.common.core.constant.HttpStatus; import com.muyu.common.core.constant.HttpStatus;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
@ -33,10 +34,28 @@ public class Result<T> implements Serializable {
public static final int WARN = HttpStatus.WARN; public static final int WARN = HttpStatus.WARN;
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
@Schema(
name = "code",
title = "返回状态码",
type = "int",
description = "请求后台返回的状态码 200表示成功 500表示服务器错误"
)
private int code; private int code;
@Schema(
name = "msg",
title = "返回状态信息",
type = "String",
description = "请求后台返回的状态详细信息"
)
private String msg; private String msg;
@Schema(
name = "data",
title = "返回对象",
description = "请求后台返回的对象"
)
private T data; private T data;
public static <T> Result<T> success () { public static <T> Result<T> success () {

View File

@ -4,6 +4,7 @@ import com.baomidou.mybatisplus.annotation.TableField;
import com.fasterxml.jackson.annotation.JsonFormat; import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonInclude;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
@ -36,22 +37,46 @@ public class BaseEntity implements Serializable {
/** /**
* *
*/ */
@Schema(
name = "createBy",
title = "创建人",
type = "String",
description = "创建数据的用户"
)
private String createBy; private String createBy;
/** /**
* *
*/ */
@Schema(
name = "createTime",
title = "创建时间",
type = "Date",
description = "创建数据的时间"
)
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date createTime; private Date createTime;
/** /**
* *
*/ */
@Schema(
name = "updateBy",
title = "更新者",
type = "String",
description = "更新数据的用户"
)
private String updateBy; private String updateBy;
/** /**
* *
*/ */
@Schema(
name = "updateTime",
title = "更新时间",
type = "Date",
description = "更新数据的时间"
)
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date updateTime; private Date updateTime;