♻️ Refactoring code. 使用openapi3 替代swagger2

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/dto/AppUserDTO.java

@@ -1,22 +1,21 @@
 package com.pig4cloud.pigx.app.api.dto;
 
 import com.pig4cloud.pigx.app.api.entity.AppUser;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
 import java.util.List;
 
 @Data
-@ApiModel(value = "APP用户传输对象")
+@Schema(description = "APP用户传输对象")
 @EqualsAndHashCode(callSuper = true)
 public class AppUserDTO extends AppUser {
 
 	/**
 	 * 角色ID
 	 */
-	@ApiModelProperty(value = "角色id集合")
+	@Schema(description = "角色id集合")
 	private List<Long> role;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/dto/AppUserInfo.java

@@ -20,8 +20,7 @@
 package com.pig4cloud.pigx.app.api.dto;
 
 import com.pig4cloud.pigx.app.api.entity.AppUser;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -31,25 +30,25 @@ import java.io.Serializable;
  * @date 2017/11/11
  */
 @Data
-@ApiModel(value = "用户信息")
+@Schema(description = "用户信息")
 public class AppUserInfo implements Serializable {
 
 	/**
 	 * 用户基本信息
 	 */
-	@ApiModelProperty(value = "用户基本信息")
+	@Schema(description = "用户基本信息")
 	private AppUser appUser;
 
 	/**
 	 * 权限标识集合
 	 */
-	@ApiModelProperty(value = "权限标识集合")
+	@Schema(description = "权限标识集合")
 	private String[] permissions;
 
 	/**
 	 * 角色集合
 	 */
-	@ApiModelProperty(value = "角色标识集合")
+	@Schema(description = "角色标识集合")
 	private Long[] roles;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/entity/AppMenu.java

@@ -21,8 +21,7 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import com.baomidou.mybatisplus.extension.activerecord.Model;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -37,7 +36,7 @@ import java.time.LocalDateTime;
 @Data
 @TableName("app_menu")
 @EqualsAndHashCode(callSuper = true)
-@ApiModel(value = "菜单权限表")
+@Schema(description = "菜单权限表")
 public class AppMenu extends Model<AppMenu> {
 
 	private static final long serialVersionUID = 1L;
@@ -46,85 +45,85 @@ public class AppMenu extends Model<AppMenu> {
 	 * 菜单ID
 	 */
 	@TableId(type = IdType.ASSIGN_ID)
-	@ApiModelProperty(value = "菜单ID")
+	@Schema(description = "菜单ID")
 	private Long menuId;
 
 	/**
 	 * name
 	 */
-	@ApiModelProperty(value = "name")
+	@Schema(description = "name")
 	private String name;
 
 	/**
 	 * permission
 	 */
-	@ApiModelProperty(value = "permission")
+	@Schema(description = "permission")
 	private String permission;
 
 	/**
 	 * path
 	 */
-	@ApiModelProperty(value = "path")
+	@Schema(description = "path")
 	private String path;
 
 	/**
 	 * 父菜单ID
 	 */
-	@ApiModelProperty(value = "父菜单ID")
+	@Schema(description = "父菜单ID")
 	private Long parentId;
 
 	/**
 	 * 是否显示
 	 */
-	@ApiModelProperty(value = "是否显示")
+	@Schema(description = "是否显示")
 	private String visible;
 
 	/**
 	 * 排序值
 	 */
-	@ApiModelProperty(value = "排序值")
+	@Schema(description = "排序值")
 	private Integer sortOrder;
 
 	/**
 	 * menuType
 	 */
-	@ApiModelProperty(value = "menuType")
+	@Schema(description = "menuType")
 	private String menuType;
 
 	/**
 	 * 创建人
 	 */
-	@ApiModelProperty(value = "创建人")
+	@Schema(description = "创建人")
 	private String createBy;
 
 	/**
 	 * 创建时间
 	 */
-	@ApiModelProperty(value = "创建时间")
+	@Schema(description = "创建时间")
 	private LocalDateTime createTime;
 
 	/**
 	 * 修改人
 	 */
-	@ApiModelProperty(value = "修改人")
+	@Schema(description = "修改人")
 	private String updateBy;
 
 	/**
 	 * 更新时间
 	 */
-	@ApiModelProperty(value = "更新时间")
+	@Schema(description = "更新时间")
 	private LocalDateTime updateTime;
 
 	/**
 	 * delFlag
 	 */
-	@ApiModelProperty(value = "delFlag")
+	@Schema(description = "delFlag")
 	private String delFlag;
 
 	/**
 	 * 租户ID
 	 */
-	@ApiModelProperty(value = "租户ID", hidden = true)
+	@Schema(description = "租户ID", hidden = true)
 	private Long tenantId;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/entity/AppRole.java

@@ -21,8 +21,7 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import com.baomidou.mybatisplus.extension.activerecord.Model;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -37,7 +36,7 @@ import java.time.LocalDateTime;
 @Data
 @TableName("app_role")
 @EqualsAndHashCode(callSuper = true)
-@ApiModel(value = "app角色表")
+@Schema(description = "app角色表")
 public class AppRole extends Model<AppRole> {
 
 	private static final long serialVersionUID = 1L;
@@ -46,61 +45,61 @@ public class AppRole extends Model<AppRole> {
 	 * roleId
 	 */
 	@TableId(type = IdType.ASSIGN_ID)
-	@ApiModelProperty(value = "roleId")
+	@Schema(description = "roleId")
 	private Long roleId;
 
 	/**
 	 * roleName
 	 */
-	@ApiModelProperty(value = "roleName")
+	@Schema(description = "roleName")
 	private String roleName;
 
 	/**
 	 * roleCode
 	 */
-	@ApiModelProperty(value = "roleCode")
+	@Schema(description = "roleCode")
 	private String roleCode;
 
 	/**
 	 * roleDesc
 	 */
-	@ApiModelProperty(value = "roleDesc")
+	@Schema(description = "roleDesc")
 	private String roleDesc;
 
 	/**
 	 * 创建人
 	 */
-	@ApiModelProperty(value = "创建人")
+	@Schema(description = "创建人")
 	private String createBy;
 
 	/**
 	 * 修改人
 	 */
-	@ApiModelProperty(value = "修改人")
+	@Schema(description = "修改人")
 	private String updateBy;
 
 	/**
 	 * createTime
 	 */
-	@ApiModelProperty(value = "createTime")
+	@Schema(description = "createTime")
 	private LocalDateTime createTime;
 
 	/**
 	 * updateTime
 	 */
-	@ApiModelProperty(value = "updateTime")
+	@Schema(description = "updateTime")
 	private LocalDateTime updateTime;
 
 	/**
 	 * delFlag
 	 */
-	@ApiModelProperty(value = "delFlag")
+	@Schema(description = "delFlag")
 	private String delFlag;
 
 	/**
 	 * tenantId
 	 */
-	@ApiModelProperty(value = "tenantId", hidden = true)
+	@Schema(description = "tenantId", hidden = true)
 	private Long tenantId;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/entity/AppRoleMenu.java

@@ -21,8 +21,7 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import com.baomidou.mybatisplus.extension.activerecord.Model;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -35,7 +34,7 @@ import lombok.EqualsAndHashCode;
 @Data
 @TableName("app_role_menu")
 @EqualsAndHashCode(callSuper = true)
-@ApiModel(value = "角色菜单表")
+@Schema(description = "角色菜单表")
 public class AppRoleMenu extends Model<AppRoleMenu> {
 
 	private static final long serialVersionUID = 1L;
@@ -44,13 +43,13 @@ public class AppRoleMenu extends Model<AppRoleMenu> {
 	 * 角色ID
 	 */
 	@TableId(type = IdType.ASSIGN_ID)
-	@ApiModelProperty(value = "角色ID")
+	@Schema(description = "角色ID")
 	private Long roleId;
 
 	/**
 	 * 菜单ID
 	 */
-	@ApiModelProperty(value = "菜单ID")
+	@Schema(description = "菜单ID")
 	private Long menuId;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/entity/AppSocialDetails.java

@@ -21,8 +21,7 @@ import com.baomidou.mybatisplus.annotation.*;
 import com.baomidou.mybatisplus.extension.activerecord.Model;
 import com.pig4cloud.pigx.common.core.sensitive.Sensitive;
 import com.pig4cloud.pigx.common.core.util.ValidGroup;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -33,7 +32,7 @@ import java.time.LocalDateTime;
  * app 社交账号登录
  */
 @Data
-@ApiModel(value = "第三方账号信息")
+@Schema(description = "第三方账号信息")
 @EqualsAndHashCode(callSuper = true)
 public class AppSocialDetails extends Model<AppSocialDetails> {
 
@@ -43,20 +42,20 @@ public class AppSocialDetails extends Model<AppSocialDetails> {
 	 * 主鍵
 	 */
 	@TableId(type = IdType.ASSIGN_ID)
-	@ApiModelProperty(value = "主键")
+	@Schema(description = "主键")
 	private Long id;
 
 	/**
 	 * 类型
 	 */
 	@NotBlank(message = "类型不能为空")
-	@ApiModelProperty(value = "账号类型")
+	@Schema(description = "账号类型")
 	private String type;
 
 	/**
 	 * 描述
 	 */
-	@ApiModelProperty(value = "描述")
+	@Schema(description = "描述")
 	private String remark;
 
 	/**
@@ -64,7 +63,7 @@ public class AppSocialDetails extends Model<AppSocialDetails> {
 	 */
 	@Sensitive(prefixNoMaskLen = 4, suffixNoMaskLen = 4)
 	@NotBlank(message = "账号不能为空")
-	@ApiModelProperty(value = "appId")
+	@Schema(description = "appId")
 	private String appId;
 
 	/**
@@ -72,46 +71,46 @@ public class AppSocialDetails extends Model<AppSocialDetails> {
 	 */
 	@Sensitive(prefixNoMaskLen = 9, suffixNoMaskLen = 9)
 	@NotBlank(message = "密钥不能为空", groups = { ValidGroup.Insert.class })
-	@ApiModelProperty(value = "app secret")
+	@Schema(description = "app secret")
 	private String appSecret;
 
 	/**
 	 * 回调地址
 	 */
-	@ApiModelProperty(value = "回调地址")
+	@Schema(description = "回调地址")
 	private String redirectUrl;
 
 	/**
 	 * 拓展字段
 	 */
-	@ApiModelProperty(value = "拓展字段")
+	@Schema(description = "拓展字段")
 	private String ext;
 
 	/**
 	 * 创建人
 	 */
 	@TableField(fill = FieldFill.INSERT)
-	@ApiModelProperty(value = "创建人")
+	@Schema(description = "创建人")
 	private String createBy;
 
 	/**
 	 * 修改人
 	 */
 	@TableField(fill = FieldFill.UPDATE)
-	@ApiModelProperty(value = "修改人")
+	@Schema(description = "修改人")
 	private String updateBy;
 
 	/**
 	 * 创建时间
 	 */
-	@ApiModelProperty(value = "创建时间")
+	@Schema(description = "创建时间")
 	@TableField(fill = FieldFill.INSERT)
 	private LocalDateTime createTime;
 
 	/**
 	 * 更新时间
 	 */
-	@ApiModelProperty(value = "更新时间")
+	@Schema(description = "更新时间")
 	@TableField(fill = FieldFill.UPDATE)
 	private LocalDateTime updateTime;
 
@@ -120,7 +119,7 @@ public class AppSocialDetails extends Model<AppSocialDetails> {
 	 */
 	@TableLogic
 	@TableField(fill = FieldFill.INSERT)
-	@ApiModelProperty(value = "删除标记,1:已删除,0:正常")
+	@Schema(description = "删除标记,1:已删除,0:正常")
 	private String delFlag;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/entity/AppUser.java

@@ -20,8 +20,7 @@ package com.pig4cloud.pigx.app.api.entity;
 import com.baomidou.mybatisplus.annotation.*;
 import com.baomidou.mybatisplus.extension.activerecord.Model;
 import com.fasterxml.jackson.annotation.JsonIgnore;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -36,7 +35,7 @@ import java.time.LocalDateTime;
 @Data
 @TableName("app_user")
 @EqualsAndHashCode(callSuper = true)
-@ApiModel(value = "app用户表")
+@Schema(description = "app用户表")
 public class AppUser extends Model<AppUser> {
 
 	private static final long serialVersionUID = 1L;
@@ -45,90 +44,90 @@ public class AppUser extends Model<AppUser> {
 	 * userId
 	 */
 	@TableId(type = IdType.ASSIGN_ID)
-	@ApiModelProperty(value = "userId")
+	@Schema(description = "userId")
 	private Long userId;
 
 	/**
 	 * 用户名
 	 */
-	@ApiModelProperty(value = "用户名")
+	@Schema(description = "用户名")
 	private String username;
 
 	/**
 	 * 密码
 	 */
-	@ApiModelProperty(value = "密码")
+	@Schema(description = "密码")
 	private String password;
 
 	/**
 	 * 随机盐
 	 */
 	@JsonIgnore
-	@ApiModelProperty(value = "随机盐")
+	@Schema(description = "随机盐")
 	private String salt;
 
 	/**
 	 * 手机号
 	 */
-	@ApiModelProperty(value = "手机号")
+	@Schema(description = "手机号")
 	private String phone;
 
 	/**
 	 * 头像
 	 */
-	@ApiModelProperty(value = "头像")
+	@Schema(description = "头像")
 	private String avatar;
 
 	/**
 	 * 昵称
 	 */
-	@ApiModelProperty(value = "拓展字段:昵称")
+	@Schema(description = "拓展字段:昵称")
 	private String nickname;
 
 	/**
 	 * 姓名
 	 */
-	@ApiModelProperty(value = "拓展字段:姓名")
+	@Schema(description = "拓展字段:姓名")
 	private String name;
 
 	/**
 	 * 邮箱
 	 */
-	@ApiModelProperty(value = "拓展字段:邮箱")
+	@Schema(description = "拓展字段:邮箱")
 	private String email;
 
 	/**
 	 * 创建人
 	 */
-	@ApiModelProperty(value = "创建人")
+	@Schema(description = "创建人")
 	@TableField(fill = FieldFill.INSERT)
 	private String createBy;
 
 	/**
 	 * 修改人
 	 */
-	@ApiModelProperty(value = "修改人")
+	@Schema(description = "修改人")
 	@TableField(fill = FieldFill.UPDATE)
 	private String updateBy;
 
 	/**
 	 * 创建时间
 	 */
-	@ApiModelProperty(value = "创建时间")
+	@Schema(description = "创建时间")
 	@TableField(fill = FieldFill.INSERT)
 	private LocalDateTime createTime;
 
 	/**
 	 * 修改时间
 	 */
-	@ApiModelProperty(value = "修改时间")
+	@Schema(description = "修改时间")
 	@TableField(fill = FieldFill.UPDATE)
 	private LocalDateTime updateTime;
 
 	/**
 	 * 删除标记
 	 */
-	@ApiModelProperty(value = "删除标记,1:已删除,0:正常")
+	@Schema(description = "删除标记,1:已删除,0:正常")
 	@TableField(fill = FieldFill.INSERT)
 	@TableLogic
 	private String delFlag;
@@ -136,25 +135,25 @@ public class AppUser extends Model<AppUser> {
 	/**
 	 * 所属租户
 	 */
-	@ApiModelProperty(value = "所属租户", hidden = true)
+	@Schema(description = "所属租户", hidden = true)
 	private Long tenantId;
 
 	/**
 	 * 最后一次密码修改时间
 	 */
-	@ApiModelProperty(value = "最后一次密码修改时间")
+	@Schema(description = "最后一次密码修改时间")
 	private LocalDateTime lastModifiedTime;
 
 	/**
 	 * 锁定标记
 	 */
-	@ApiModelProperty(value = "锁定标记")
+	@Schema(description = "锁定标记")
 	private String lockFlag;
 
 	/**
 	 * 微信小程序登录openId
 	 */
-	@ApiModelProperty(value = "微信小程序登录openId")
+	@Schema(description = "微信小程序登录openId")
 	private String wxOpenid;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/entity/AppUserRole.java

@@ -21,8 +21,7 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import com.baomidou.mybatisplus.extension.activerecord.Model;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -35,7 +34,7 @@ import lombok.EqualsAndHashCode;
 @Data
 @TableName("app_user_role")
 @EqualsAndHashCode(callSuper = true)
-@ApiModel(value = "用户角色表")
+@Schema(description = "用户角色表")
 public class AppUserRole extends Model<AppUserRole> {
 
 	private static final long serialVersionUID = 1L;
@@ -44,13 +43,13 @@ public class AppUserRole extends Model<AppUserRole> {
 	 * 用户ID
 	 */
 	@TableId(type = IdType.ASSIGN_ID)
-	@ApiModelProperty(value = "用户ID")
+	@Schema(description = "用户ID")
 	private Long userId;
 
 	/**
 	 * 角色ID
 	 */
-	@ApiModelProperty(value = "角色ID")
+	@Schema(description = "角色ID")
 	private Long roleId;
 
 }

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/vo/AppRoleVO.java

@@ -17,7 +17,7 @@
 
 package com.pig4cloud.pigx.app.api.vo;
 
-import io.swagger.annotations.ApiModel;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 /**
@@ -25,7 +25,7 @@ import lombok.Data;
  * @date 2020/2/10
  */
 @Data
-@ApiModel(value = "前端角色展示对象")
+@Schema(description = "前端角色展示对象")
 public class AppRoleVO {
 
 	/**

pigx-app-server/pigx-app-server-api/src/main/java/com/pig4cloud/pigx/app/api/vo/AppUserVo.java

@@ -3,7 +3,7 @@ package com.pig4cloud.pigx.app.api.vo;
 import com.pig4cloud.pigx.app.api.entity.AppRole;
 import com.pig4cloud.pigx.common.core.sensitive.Sensitive;
 import com.pig4cloud.pigx.common.core.sensitive.SensitiveTypeEnum;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -16,86 +16,86 @@ public class AppUserVo implements Serializable {
 	/**
 	 * 主键
 	 */
-	@ApiModelProperty(value = "主键")
+	@Schema(description = "主键")
 	private Long userId;
 
 	/**
 	 * 用户名
 	 */
-	@ApiModelProperty(value = "用户名")
+	@Schema(description = "用户名")
 	private String username;
 
 	/**
 	 * 密码
 	 */
-	@ApiModelProperty(value = "密码")
+	@Schema(description = "密码")
 	private String password;
 
 	/**
 	 * 手机号
 	 */
-	@ApiModelProperty(value = "手机号")
+	@Schema(description = "手机号")
 	@Sensitive(type = SensitiveTypeEnum.MOBILE_PHONE)
 	private String phone;
 
 	/**
 	 * 头像
 	 */
-	@ApiModelProperty(value = "头像")
+	@Schema(description = "头像")
 	private String avatar;
 
 	/**
 	 * 昵称
 	 */
-	@ApiModelProperty(value = "拓展字段:昵称")
+	@Schema(description = "拓展字段:昵称")
 	private String nickname;
 
 	/**
 	 * 姓名
 	 */
-	@ApiModelProperty(value = "拓展字段:姓名")
+	@Schema(description = "拓展字段:姓名")
 	private String name;
 
 	/**
 	 * 邮箱
 	 */
-	@ApiModelProperty(value = "拓展字段:邮箱")
+	@Schema(description = "拓展字段:邮箱")
 	private String email;
 
 	/**
 	 * 创建时间
 	 */
-	@ApiModelProperty(value = "创建时间")
+	@Schema(description = "创建时间")
 	private LocalDateTime createTime;
 
 	/**
 	 * 删除标记
 	 */
-	@ApiModelProperty(value = "删除标记,1:已删除,0:正常")
+	@Schema(description = "删除标记,1:已删除,0:正常")
 	private String delFlag;
 
 	/**
 	 * 所属租户
 	 */
-	@ApiModelProperty(value = "所属租户")
+	@Schema(description = "所属租户")
 	private Long tenantId;
 
 	/**
 	 * 最后一次密码修改时间
 	 */
-	@ApiModelProperty(value = "最后一次密码修改时间")
+	@Schema(description = "最后一次密码修改时间")
 	private LocalDateTime lastModifiedTime;
 
 	/**
 	 * 锁定标记
 	 */
-	@ApiModelProperty(value = "锁定标记")
+	@Schema(description = "锁定标记")
 	private String lockFlag;
 
 	/**
 	 * 角色列表
 	 */
-	@ApiModelProperty(value = "拥有的角色列表")
+	@Schema(description = "拥有的角色列表")
 	private List<AppRole> roleList;
 
 }