From 82f0db2e7ce215c51b5abefbebe6e3b4607761b6 Mon Sep 17 00:00:00 2001
From: KKSU <15274802129@163.com>
Date: Tue, 26 Nov 2024 10:16:03 +0800
Subject: [PATCH] feat:为响应类添加 Swagger 注解
---
src/main/java/com/best/javaSdk/kdTraceQuery/response/Trace.java | 13 +++++++++++++
src/main/java/com/best/javaSdk/kdTraceQuery/response/KdTraceQueryRsp.java | 2 ++
src/main/java/com/best/javaSdk/kdTraceQuery/response/TraceLogs.java | 8 ++++++++
src/main/java/cc/mrbird/febs/mall/controller/CommonController.java | 8 +++++---
src/main/java/com/best/javaSdk/kdTraceQuery/response/Traces.java | 5 +++++
5 files changed, 33 insertions(+), 3 deletions(-)
diff --git a/src/main/java/cc/mrbird/febs/mall/controller/CommonController.java b/src/main/java/cc/mrbird/febs/mall/controller/CommonController.java
index 7db03b9..dbe5a30 100644
--- a/src/main/java/cc/mrbird/febs/mall/controller/CommonController.java
+++ b/src/main/java/cc/mrbird/febs/mall/controller/CommonController.java
@@ -9,12 +9,11 @@
import cc.mrbird.febs.mall.dto.Base64UploadDto;
import cc.mrbird.febs.mall.entity.DataDictionaryCustom;
import cc.mrbird.febs.mall.service.ICommonService;
+import cc.mrbird.febs.mall.vo.OrderListVo;
import cn.hutool.core.util.IdUtil;
import cn.hutool.core.util.StrUtil;
import com.best.javaSdk.kdTraceQuery.response.KdTraceQueryRsp;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.*;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
@@ -214,6 +213,9 @@
}
@ApiOperation(value = "获取快递信息接口")
+ @ApiResponses({
+ @ApiResponse(code = 200, message = "success", response = KdTraceQueryRsp.class)
+ })
@PostMapping(value = "/checkTraceInfo")
public FebsResponse checkTraceInfo(@RequestBody ApiCheckTraceInfoDto checkTraceInfoDto) {
diff --git a/src/main/java/com/best/javaSdk/kdTraceQuery/response/KdTraceQueryRsp.java b/src/main/java/com/best/javaSdk/kdTraceQuery/response/KdTraceQueryRsp.java
index 79038e9..603d362 100644
--- a/src/main/java/com/best/javaSdk/kdTraceQuery/response/KdTraceQueryRsp.java
+++ b/src/main/java/com/best/javaSdk/kdTraceQuery/response/KdTraceQueryRsp.java
@@ -1,6 +1,7 @@
package com.best.javaSdk.kdTraceQuery.response;
import com.best.javaSdk.BaseResponse;
+import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@@ -8,6 +9,7 @@
@Data
+@ApiModel(value = "KdTraceQueryRsp", description = "信息返回类")
public class KdTraceQueryRsp implements BaseResponse {
@ApiModelProperty(value = "请求结果", example = "60850007041815")
diff --git a/src/main/java/com/best/javaSdk/kdTraceQuery/response/Trace.java b/src/main/java/com/best/javaSdk/kdTraceQuery/response/Trace.java
index e6d8967..89ac167 100644
--- a/src/main/java/com/best/javaSdk/kdTraceQuery/response/Trace.java
+++ b/src/main/java/com/best/javaSdk/kdTraceQuery/response/Trace.java
@@ -1,17 +1,30 @@
package com.best.javaSdk.kdTraceQuery.response;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+@ApiModel(value = "Trace", description = "信息返回类")
public class Trace {
+ @ApiModelProperty(value = "收件人类型", example = "60850007041815")
private String receiverType;
+ @ApiModelProperty(value = "收件人姓名", example = "60850007041815")
private String receiverName;
+ @ApiModelProperty(value = "收件人电子签名", example = "60850007041815")
private String receiverSignature;
+ @ApiModelProperty(value = "收件包裹图片", example = "60850007041815")
private String receiverImage;
+ @ApiModelProperty(value = "包裹状态 ", example = "60850007041815")
private String packageStatusCode;
+ @ApiModelProperty(value = "包裹状态描述 ", example = "60850007041815")
private String statusCodeDesc;
+ @ApiModelProperty(value = "扫描时间 ", example = "60850007041815")
private String operateTime;
+ @ApiModelProperty(value = "当前城市 ", example = "60850007041815")
private String currentCity;
+ @ApiModelProperty(value = "目标城市 ", example = "60850007041815")
private String nextCity;
+ @ApiModelProperty(value = "备注 ", example = "60850007041815")
private String remark;
public String getReceiverType()
diff --git a/src/main/java/com/best/javaSdk/kdTraceQuery/response/TraceLogs.java b/src/main/java/com/best/javaSdk/kdTraceQuery/response/TraceLogs.java
index a0285d1..a6dc686 100644
--- a/src/main/java/com/best/javaSdk/kdTraceQuery/response/TraceLogs.java
+++ b/src/main/java/com/best/javaSdk/kdTraceQuery/response/TraceLogs.java
@@ -1,10 +1,18 @@
package com.best.javaSdk.kdTraceQuery.response;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel(value = "TraceLogs", description = "信息返回类")
public class TraceLogs {
+ @ApiModelProperty(value = "运单号", example = "60850007041815")
private String mailNo;
+ @ApiModelProperty(value = "订单号", example = "60850007041815")
private String txLogisticId;
+ @ApiModelProperty(value = "重量，单位 kg ", example = "60850007041815")
private double weight;
+ @ApiModelProperty(value = "快递物流详情", example = "60850007041815")
private Traces traces;
public String getMailNo()
diff --git a/src/main/java/com/best/javaSdk/kdTraceQuery/response/Traces.java b/src/main/java/com/best/javaSdk/kdTraceQuery/response/Traces.java
index f37465c..7d42161 100644
--- a/src/main/java/com/best/javaSdk/kdTraceQuery/response/Traces.java
+++ b/src/main/java/com/best/javaSdk/kdTraceQuery/response/Traces.java
@@ -1,9 +1,14 @@
package com.best.javaSdk.kdTraceQuery.response;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
import java.util.List;
+@ApiModel(value = "Traces", description = "信息返回类")
public class Traces {
+ @ApiModelProperty(value = "快递物流详情列表", example = "60850007041815")
private List<Trace> trace;
public List<Trace> getTrace()
--
Gitblit v1.9.1