feat(swagger): 升级Swagger至OpenAPI3并更新相关注解

This commit is contained in:
2025-10-31 10:36:13 +08:00
parent 55f9846b17
commit 075764785e
105 changed files with 564 additions and 603 deletions
@@ -20,8 +20,7 @@ import com.alibaba.fastjson2.annotation.JSONField;
import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
@@ -40,16 +39,16 @@ import java.util.Date;
@Setter
@ToString
@TableName("task_instance_detail")
@ApiModel(value = "TaskInstanceDetailTb对象", description = "任务实例明细")
@Schema(name = "TaskInstanceDetailTb对象", description = "任务实例明细")
public class TaskInstanceDetailTb extends CsObject {
@TableField(fill = FieldFill.INSERT)
@ApiModelProperty(value = "创建时间: yyyy-MM-dd HH:mm:ss", hidden = true)
@Schema(name = "创建时间: yyyy-MM-dd HH:mm:ss", hidden = true)
private Date createTime;
/**
* id
*/
@ApiModelProperty("id")
@Schema(name="id")
@TableId(value = "id", type = IdType.ASSIGN_ID)
@JsonSerialize(using = ToStringSerializer.class)
@JSONField(format = "string")
@@ -59,20 +58,20 @@ public class TaskInstanceDetailTb extends CsObject {
* 任务实例id
*/
@TableField("instance_id")
@ApiModelProperty("任务实例id")
@Schema(name="任务实例id")
private Long instanceId;
/**
* 开始时间
*/
@ApiModelProperty("开始时间")
@Schema(name="开始时间")
@TableField("start_time")
private Date startTime;
/**
* 结束时间
*/
@ApiModelProperty("结束时间")
@Schema(name="结束时间")
@TableField("finish_time")
private Date finishTime;
@@ -80,27 +79,27 @@ public class TaskInstanceDetailTb extends CsObject {
* 业务编码
*/
@TableField("biz_code")
@ApiModelProperty("业务编码")
@Schema(name="业务编码")
private String bizCode;
/**
* 业务名称(步骤)
*/
@TableField("biz_name")
@ApiModelProperty("业务名称(步骤)")
@Schema(name="业务名称(步骤)")
private String bizName;
/**
* 执行参数
*/
@ApiModelProperty("执行参数")
@Schema(name="执行参数")
@TableField("execute_params")
private String executeParams;
/**
* 执行信息
*/
@ApiModelProperty("执行信息")
@Schema(name="执行信息")
@TableField("execute_info")
private String executeInfo;
@@ -108,6 +107,6 @@ public class TaskInstanceDetailTb extends CsObject {
* 执行状态(running进行中 success成功 fail失败)
*/
@TableField("execute_status")
@ApiModelProperty("执行状态(running进行中 success成功 fail失败)")
@Schema(name="执行状态(running进行中 success成功 fail失败)")
private String executeStatus;
}
@@ -20,8 +20,7 @@ import com.alibaba.fastjson2.annotation.JSONField;
import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
@@ -41,25 +40,25 @@ import java.util.Date;
@Setter
@ToString
@TableName("task_instance_info")
@ApiModel(value = "TaskInstanceInfoTb对象", description = "任务实例")
@Schema(name = "TaskInstanceInfoTb对象", description = "任务实例")
public class TaskInstanceInfoTb extends CsObject {
@CreatedBy
@TableField(fill = FieldFill.INSERT)
@ApiModelProperty(value = "创建人", hidden = true)
@Schema(name = "创建人", hidden = true)
private String createBy;
@TableField(fill = FieldFill.INSERT)
@ApiModelProperty(value = "创建时间: yyyy-MM-dd HH:mm:ss", hidden = true)
@Schema(name = "创建时间: yyyy-MM-dd HH:mm:ss", hidden = true)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
@ApiModelProperty(value = "更新时间: yyyy-MM-dd HH:mm:ss", hidden = true)
@Schema(name = "更新时间: yyyy-MM-dd HH:mm:ss", hidden = true)
private Date updateTime;
/**
* id, @JsonSerialize和@JSONField,用于处理大数精度丢失问题
*/
@ApiModelProperty("id")
@Schema(name="id")
@TableId(value = "id", type = IdType.ASSIGN_ID)
@JsonSerialize(using = ToStringSerializer.class)
@JSONField(format = "string")
@@ -68,21 +67,21 @@ public class TaskInstanceInfoTb extends CsObject {
/**
* 名称
*/
@ApiModelProperty("名称")
@Schema(name="名称")
@TableField("context_name")
private String contextName;
/**
* 语言
*/
@ApiModelProperty("语言")
@Schema(name="语言")
@TableField("`language`")
private String language;
/**
* 变更类型
*/
@ApiModelProperty("变更类型")
@Schema(name="变更类型")
@TableField("change_type")
private String changeType;
@@ -90,27 +89,27 @@ public class TaskInstanceInfoTb extends CsObject {
* 环境别名
*/
@TableField("env_alias")
@ApiModelProperty("环境别名")
@Schema(name="环境别名")
private String envAlias;
/**
* 状态(running进行中 success成功 fail失败)
*/
@TableField("`status`")
@ApiModelProperty("状态(running进行中 success成功 fail失败)")
@Schema(name="状态(running进行中 success成功 fail失败)")
private String status;
/**
* 完成时间
*/
@ApiModelProperty("完成时间")
@Schema(name="完成时间")
@TableField("finish_time")
private Date finishTime;
/**
* 来源
*/
@ApiModelProperty("来源")
@Schema(name="来源")
@TableField("`source`")
private String source;
@@ -118,27 +117,27 @@ public class TaskInstanceInfoTb extends CsObject {
* 变更原因
*/
@TableField("reason")
@ApiModelProperty("变更原因")
@Schema(name="变更原因")
private String reason;
/**
* 任务模板
*/
@TableField("template")
@ApiModelProperty("template")
@Schema(name="template")
private String template;
/**
* QuartzJob参数
*/
@TableField("job_data")
@ApiModelProperty("QuartzJob参数")
@Schema(name="QuartzJob参数")
private String jobData;
/**
* 异常信息
*/
@TableField("error_message")
@ApiModelProperty("异常信息")
@Schema(name="异常信息")
private String errorMessage;
}
@@ -20,8 +20,7 @@ import com.alibaba.fastjson2.annotation.JSONField;
import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
@@ -41,16 +40,16 @@ import java.util.Date;
@Setter
@ToString
@TableName("task_instance_step_detail")
@ApiModel(value = "TaskInstanceStepDetailTb对象", description = "")
@Schema(name = "TaskInstanceStepDetailTb对象", description = "")
public class TaskInstanceStepDetailTb extends CsObject {
@TableField(fill = FieldFill.INSERT)
@ApiModelProperty(value = "创建时间: yyyy-MM-dd HH:mm:ss", hidden = true)
@Schema(name = "创建时间: yyyy-MM-dd HH:mm:ss", hidden = true)
private Date createTime;
/**
* id
*/
@ApiModelProperty("id")
@Schema(name="id")
@TableId(value = "id", type = IdType.ASSIGN_ID)
@JsonSerialize(using = ToStringSerializer.class)
@JSONField(format = "string")
@@ -60,20 +59,20 @@ public class TaskInstanceStepDetailTb extends CsObject {
* task_instance_detail表id
*/
@TableField("instance_detail_id")
@ApiModelProperty("task_instance_detail表id")
@Schema(name="task_instance_detail表id")
private Long instanceDetailId;
/**
* 步骤描述
*/
@TableField("step_desc")
@ApiModelProperty("步骤描述")
@Schema(name="步骤描述")
private String stepDesc;
/**
* 状态(success成功 fail失败)
*/
@TableField("step_status")
@ApiModelProperty("状态(success成功 fail失败)")
@Schema(name="状态(success成功 fail失败)")
private String stepStatus;
}
@@ -20,8 +20,7 @@ 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 io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
@@ -39,13 +38,13 @@ import lombok.ToString;
@Setter
@ToString
@TableName("task_template_info")
@ApiModel(value = "TaskTemplateInfoTb对象", description = "任务模板")
@Schema(name = "TaskTemplateInfoTb对象", description = "任务模板")
public class TaskTemplateInfoTb extends CsBaseUserTimeTb {
/**
* id
*/
@ApiModelProperty("id")
@Schema(name="id")
@TableId(value = "id", type = IdType.AUTO)
private Long id;
@@ -53,13 +52,13 @@ public class TaskTemplateInfoTb extends CsBaseUserTimeTb {
* 数据有效性
*/
@TableField("available")
@ApiModelProperty("数据有效性")
@Schema(name="数据有效性")
private Boolean available;
/**
* 变更类型
*/
@ApiModelProperty("变更类型")
@Schema(name="变更类型")
@TableField("change_type")
private String changeType;
@@ -67,13 +66,13 @@ public class TaskTemplateInfoTb extends CsBaseUserTimeTb {
* 流水线名称
*/
@TableField("`name`")
@ApiModelProperty("流水线名称")
@Schema(name="流水线名称")
private String name;
/**
* 流水线描述
*/
@ApiModelProperty("流水线描述")
@Schema(name="流水线描述")
@TableField("`description`")
private String description;
@@ -81,20 +80,20 @@ public class TaskTemplateInfoTb extends CsBaseUserTimeTb {
* 流水线模板内容
*/
@TableField("template")
@ApiModelProperty("流水线模板内容")
@Schema(name="流水线模板内容")
private String template;
/**
* 环境别名
*/
@TableField("env_alias")
@ApiModelProperty("环境别名")
@Schema(name="环境别名")
private String envAlias;
/**
* 应用为语言,资源为类型
*/
@TableField("`language`")
@ApiModelProperty("应用为语言,资源为类型")
@Schema(name="应用为语言,资源为类型")
private String language;
}