Procházet zdrojové kódy

新增swagger注释

donglang před 2 měsíci
rodič
revize
a632436465

+ 6 - 0
sckw-common/sckw-common-core/pom.xml

@@ -184,5 +184,11 @@
             <version>3.3.4</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.alibaba</groupId>
+            <artifactId>druid</artifactId>
+            <version>1.2.19</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 </project>

+ 0 - 1
sckw-common/sckw-common-core/src/main/java/com/sckw/core/model/page/PageRequest.java

@@ -1,5 +1,4 @@
 package com.sckw.core.model.page;
-
 import lombok.Data;
 
 /**

+ 1 - 1
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/KwpBizWalletController.java

@@ -31,7 +31,7 @@ import java.util.List;
  * Des: 钱包管理Controller
  * Version: 1.0
  */
-@Tag(name = "钱包管理", description = "提供钱包相关操作接口")
+@Tag(name = "线下钱包管理", description = "提供钱包相关操作接口")
 @RestController
 @RequestMapping("/biz/wallet")
 @RequiredArgsConstructor

+ 7 - 1
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/repose/KwpBizWalletPageResponse.java

@@ -3,6 +3,7 @@ package com.sckw.payment.repose;
 
 import com.sckw.core.model.page.PageResult;
 import com.sckw.payment.repose.vo.KwpBizWalletVO;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.math.BigDecimal;
@@ -21,26 +22,31 @@ public class KwpBizWalletPageResponse extends PageResult {
     /**
      * 企业id
      */
+    @Schema(description = "企业id")
     private Long entId;
 
     /**
      * 企业名称
      */
+    @Schema(description = "企业名称")
     private String entName;
 
     /**
      * 钱包数量
      */
+    @Schema(description = "钱包数量")
     private int walletNum;
 
     /**
-     * 钱包数量
+     * 钱包金额
      */
+    @Schema(description = "钱包金额")
     private BigDecimal totalAmount;
 
     /**
      * 钱包信息
      */
+    @Schema(description = "钱包信息")
     private List<KwpBizWalletVO> walletVOList;
 
 

+ 15 - 1
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/repose/KwpBizWalletPrepayPageResponse.java

@@ -6,6 +6,7 @@ import com.baomidou.mybatisplus.annotation.TableField;
 import com.fasterxml.jackson.annotation.JsonFormat;
 import com.sckw.core.model.page.PageResult;
 import com.sckw.payment.model.KwpBizWalletPrepay;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.math.BigDecimal;
@@ -24,46 +25,55 @@ public class KwpBizWalletPrepayPageResponse extends PageResult {
     /**
      * 主键
      */
+    @Schema(description = "主键")
     private Long id;
 
     /**
      * 钱包id
      */
+    @Schema(description = "钱包id")
     private Long walletId;
 
     /**
      * 订单id
      */
+    @Schema(description = "订单id")
     private Long orderId;
 
     /**
      * 本次更新金额(单位:元,保留2位小数)
      */
+    @Schema(description = "本次更新金额")
     private BigDecimal changeAmount;
 
     /**
      * 可用金额
      */
+    @Schema(description = "可用金额")
     private BigDecimal amount;
 
     /**
      * 冻结金额
      */
+    @Schema(description = "冻结金额")
     private BigDecimal prepayAmount;
 
     /**
-     * 动帐类型  0-冻结、1-预付、2-解冻、3-消费',
+     * 动帐类型  0-冻结、1-预付、2-解冻、3-消费
      */
+    @Schema(description = "动帐类型  0-冻结、1-预付、2-解冻、3-消费")
     private Integer type;
 
     /**
      * 凭证URL地址
      */
+    @Schema(description = "凭证URL地址")
     private String voucherUrl;
 
     /**
      * 备注
      */
+    @Schema(description = "备注")
     private String remark;
 
     /**
@@ -71,6 +81,7 @@ public class KwpBizWalletPrepayPageResponse extends PageResult {
      */
     @TableField(value = "create_time", fill = FieldFill.INSERT)
     @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
+    @Schema(description = "创建时间")
     private Date createTime;
 
     /**
@@ -78,18 +89,21 @@ public class KwpBizWalletPrepayPageResponse extends PageResult {
      */
     @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
     @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
+    @Schema(description = "更新时间")
     private Date updateTime;
 
     /**
      * 创建人
      */
     @TableField(value = "create_user")
+    @Schema(description = "创建人")
     private String createUser;
 
     /**
      * 更新人
      */
     @TableField(value = "update_user")
+    @Schema(description = "更新人")
     private String updateUser;
 
 

+ 15 - 0
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/repose/vo/KwpBizWalletVO.java

@@ -3,6 +3,7 @@ package com.sckw.payment.repose.vo;
 
 import com.sckw.core.model.page.PageResult;
 import com.sckw.payment.model.KwpBizWallet;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.math.BigDecimal;
@@ -21,71 +22,85 @@ public class KwpBizWalletVO extends PageResult {
     /**
      * 主键
      */
+    @Schema(description = "主键")
     private Long id;
 
     /**
      * 供应商企业id
      */
+    @Schema(description = "供应商企业id")
     private Long supEntId;
 
     /**
      * 供应商企业名称
      */
+    @Schema(description = "供应商企业名称")
     private String supEntName;
 
     /**
      * 采购商企业id
      */
+    @Schema(description = "采购商企业id")
     private Long proEntId;
 
     /**
      * 采购商企业名称
      */
+    @Schema(description = "采购商企业名称")
     private String proEntName;
 
     /**
      * 钱包名称
      */
+    @Schema(description = "钱包名称")
     private String name;
 
     /**
      * 可用金额(单位:元,保留2位小数)
      */
+    @Schema(description = "可用金额")
     private BigDecimal amount;
 
     /**
      * 冻结金额(单位:元,保留2位小数)
      */
+    @Schema(description = "冻结金额")
     private BigDecimal prepayAmount;
 
     /**
      * 类型 0-线下钱包
      */
+    @Schema(description = "类型 0-线下钱包")
     private Integer type;
 
     /**
      * 状态 1-开启,0-关闭
      */
+    @Schema(description = "状态 1-开启,0-关闭")
     private Integer state;
 
     /**
      * 创建时间
      */
+    @Schema(description = "创建时间")
     private Date createTime;
 
     /**
      * 更新时间
      */
+    @Schema(description = "更新时间")
     private Date updateTime;
 
     /**
      * 创建人
      */
+    @Schema(description = "创建人")
     private String createUser;
 
     /**
      * 更新人
      */
+    @Schema(description = "更新人")
     private String updateUser;
 
     private static KwpBizWalletVO getInstance() {

+ 8 - 0
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/request/KwpBizWalletPrepayQueryRequest.java

@@ -2,6 +2,7 @@ package com.sckw.payment.request;
 
 
 import com.sckw.core.model.page.PageRequest;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Data;
 
@@ -22,36 +23,43 @@ public class KwpBizWalletPrepayQueryRequest extends PageRequest {
      * 钱包id
      */
     @NotNull(message = "钱包id不能为空!")
+    @Schema(description = "钱包id")
     private Long walletId;
 
     /**
      * 最小金额
      */
+    @Schema(description = "最小金额")
     private BigDecimal minAmount;
 
     /**
      * 最大金额
      */
+    @Schema(description = "最大金额")
     private BigDecimal maxAmount;
 
     /**
      * 动帐类型  0-冻结、1-预付、2-解冻、3-消费
      */
+    @Schema(description = "动帐类型  0-冻结、1-预付、2-解冻、3-消费")
     private Integer type;
 
     /**
      * 备注
      */
+    @Schema(description = "备注")
     private String remark;
 
     /**
      * 开始时间
      */
+    @Schema(description = "开始时间")
     private LocalDateTime startTime;
 
     /**
      * 结束时间
      */
+    @Schema(description = "结束时间")
     private LocalDateTime endTime;
 
 }

+ 7 - 1
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/request/KwpBizWalletPrepayRequest.java

@@ -2,6 +2,7 @@ package com.sckw.payment.request;
 
 
 import com.sckw.core.model.page.PageRequest;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import lombok.Data;
@@ -21,29 +22,34 @@ public class KwpBizWalletPrepayRequest extends PageRequest {
     /**
      * 钱包id
      */
+    @Schema(description = "钱包id")
     private Long walletId;
 
     /**
      * 本次更新金额(单位:元,保留2位小数)
      */
     @NotNull(message = "金额不能为空!")
+    @Schema(description = "本次更新金额")
     private BigDecimal amount;
 
     /**
-     * 动帐类型  0-冻结、1-预付、2-解冻、3-消费',
+     * 动帐类型  0-冻结、1-预付、2-解冻、3-消费
      */
     @NotNull(message = "资金方向不能为空!")
+    @Schema(description = "动帐类型  0-冻结、1-预付、2-解冻、3-消费")
     private Integer type;
 
     /**
      * 备注
      */
     @NotBlank(message = "备注不能为空!")
+    @Schema(description = "备注")
     private String remark;
 
     /**
      * 凭证URL地址
      */
+    @Schema(description = "凭证URL地址")
     private String voucherUrl;
 
 

+ 3 - 0
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/request/KwpBizWalletQueryRequest.java

@@ -2,6 +2,7 @@ package com.sckw.payment.request;
 
 
 import com.sckw.core.model.page.PageRequest;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 /**
@@ -17,11 +18,13 @@ public class KwpBizWalletQueryRequest extends PageRequest {
     /**
      * 供应商企业名称
      */
+    @Schema(description = "供应商企业名称")
     private String supEntName;
 
     /**
      * 采购商企业名称
      */
+    @Schema(description = "采购商企业名称")
     private String proEntName;
 
 }

+ 3 - 0
sckw-modules/sckw-payment/src/main/java/com/sckw/payment/request/KwpBizWalletSaveRequest.java

@@ -1,6 +1,7 @@
 package com.sckw.payment.request;
 
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Data;
 
@@ -18,12 +19,14 @@ public class KwpBizWalletSaveRequest {
      * 供应商企业id
      */
     @NotNull(message = "供应商不能为空!")
+    @Schema(description = "供应商企业id")
     private Long supEntId;
 
     /**
      * 采购商企业id
      */
     @NotNull(message = "采购商不能为空!")
+    @Schema(description = "采购商企业id")
     private Long proEntId;
 
 }