Commit 00e68e3a authored by Allen Chen's avatar Allen Chen

注释

parent 55e04e6e
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
import org.ta.pddserver.model.common.PageTool; import org.ta.pddserver.model.common.PageTool;
@Data @Data
public class CollectMailDetailRequest extends PageTool { public class CollectMailDetailRequest extends PageTool {
@Schema(
description = "搜索运单号,模糊搜索",
example = "PC123456",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String mailNo; private String mailNo;
private String orderCode;
} }
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
import org.ta.pddserver.model.common.PageTool; import org.ta.pddserver.model.common.PageTool;
@Data @Data
public class CollectOrderListRequest extends PageTool { public class CollectOrderListRequest extends PageTool {
@Schema(
description = "搜索集运单号,模糊搜索",
example = "PC123456",
minLength = 0,
maxLength = 20,
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String orderCode; private String orderCode;
@Schema(
description = "订单状态,精准搜索",
example = "0",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private int status; private int status;
} }
package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import java.util.List;
@Data
public class FinishUnpackPackageRequest {
// private String mailNo;
@Schema(
description = "集运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String orderCode;
@Schema(
description = "异常编号",
example = "103",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private int code;
@Schema(
description = "集运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private String logisticsOrderCode;
// private String status;
@Schema(
description = "NORMAL",
example = "",
defaultValue = "NORMAL",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String goodsType;
@Schema(
description = "接口",
example = "finish_pick",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String action;
@Schema(
description = "包裹信息列表",
example = "",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private List<PackageInfo> packageInfo;
/**
* 包裹详情
*/
@Data
public static class PackageInfo {
@Schema(
description = "包裹长度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long length;
@Schema(
description = "包裹宽度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long width;
@Schema(
description = "包裹高度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long height;
@Schema(
description = "实重重量,单位默认为克",
example = "2",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long weight;
}
}
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
import java.util.List; import java.util.List;
...@@ -7,20 +8,56 @@ import java.util.List; ...@@ -7,20 +8,56 @@ import java.util.List;
@Data @Data
public class FinishUnpackRequest { public class FinishUnpackRequest {
private String mailNo; // private String mailNo;
@Schema(
description = "集运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String orderCode; private String orderCode;
@Schema(
description = "异常编号",
example = "103",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private int code; private int code;
@Schema(
description = "集运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private String logisticsOrderCode; private String logisticsOrderCode;
private String status; // private String status;
@Schema(
description = "NORMAL",
example = "接口为finish_unpack 时 必填",
defaultValue = "NORMAL",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private String goodsType; private String goodsType;
@Schema(
description = "接口",
example = "finish_pick",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String action; private String action;
@Schema(
description = "包裹信息列表",
example = "",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private List<PackageInfo> packageInfo; private List<PackageInfo> packageInfo;
/** /**
...@@ -29,12 +66,36 @@ public class FinishUnpackRequest { ...@@ -29,12 +66,36 @@ public class FinishUnpackRequest {
@Data @Data
public static class PackageInfo { public static class PackageInfo {
@Schema(
description = "包裹长度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long length; private Long length;
@Schema(
description = "包裹宽度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long width; private Long width;
@Schema(
description = "包裹高度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long height; private Long height;
@Schema(
description = "实重重量,单位默认为克",
example = "2",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long weight; private Long weight;
} }
......
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
@Data @Data
public class InBoundRequest { public class InBoundRequest {
@Schema(
description = "运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String mailNo; private String mailNo;
private String logisticsOrderCode; // private String logisticsOrderCode;
private String orderCode; // private String orderCode;
private String action; // private String action;
private String status; // private String status;
@Schema(
description = "包裹长度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long length; private Long length;
@Schema(
description = "包裹宽度,单位默认为厘米",
example = "2",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long width; private Long width;
@Schema(
description = "包裹高度,单位默认为厘米",
example = "3",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long height; private Long height;
@Schema(
description = "计费重量,单位默认为克",
example = "4",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long weight; private Long weight;
@Schema(
description = "实际重量,单位默认为克",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long actualWeight; private Long actualWeight;
@Schema(
description = "异常编号",
example = "130",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private Integer code; private Integer code;
@Schema(
description = "实际货品类型",
example = "NORMAL",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String goodsType; private String goodsType;
} }
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
import org.ta.pddserver.model.common.PageTool; import org.ta.pddserver.model.common.PageTool;
@Data @Data
public class LogOrderMailDetailListRequest extends PageTool { public class LogOrderMailDetailListRequest extends PageTool {
@Schema(
description = "搜索集运单号,模糊搜索",
example = "PC123456",
minLength = 0,
maxLength = 20,
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String logisticsOrderCode; private String logisticsOrderCode;
@Schema(
description = "搜索运单号,模糊搜索",
example = "PC123456",
minLength = 0,
maxLength = 20,
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String mailNo; private String mailNo;
private int status; private int status;
} }
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
import org.ta.pddserver.model.common.PageTool; import org.ta.pddserver.model.common.PageTool;
@Data @Data
public class LogOrderPackageListRequest extends PageTool { public class LogOrderPackageListRequest extends PageTool {
@Schema(
description = "搜索集运单号,模糊搜索",
example = "PC123456",
minLength = 0,
maxLength = 20,
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String logisticsOrderCode; private String logisticsOrderCode;
private String packageType; private String packageType;
......
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
@Data @Data
public class MailNoRequest { public class MailNoRequest {
@Schema(
description = "搜索运单号,模糊搜索",
example = "PC123456",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String mailNo; private String mailNo;
private String status; // private String status;
} }
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
import java.util.List; import java.util.List;
...@@ -7,12 +8,36 @@ import java.util.List; ...@@ -7,12 +8,36 @@ import java.util.List;
@Data @Data
public class OutBoundRequest { public class OutBoundRequest {
@Schema(
description = "运单号列表",
example = "",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private List<OutBoundList> outBound; private List<OutBoundList> outBound;
@Schema(
description = "集运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String orderCode; private String orderCode;
@Schema(
description = "订单信息列表",
example = "",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private List<OutPackage> outPackageList; private List<OutPackage> outPackageList;
@Schema(
description = "异常原因编号",
example = "103",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Result result; private Result result;
...@@ -21,6 +46,12 @@ public class OutBoundRequest { ...@@ -21,6 +46,12 @@ public class OutBoundRequest {
*/ */
@Data @Data
public static class OutBoundList { public static class OutBoundList {
@Schema(
description = "运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String mailNo; private String mailNo;
...@@ -28,25 +59,87 @@ public class OutBoundRequest { ...@@ -28,25 +59,87 @@ public class OutBoundRequest {
@Data @Data
public static class OutPackage { public static class OutPackage {
@Schema(
description = "包裹长度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long length; private Long length;
@Schema(
description = "包裹宽度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long width; private Long width;
@Schema(
description = "包裹高度,单位默认为厘米",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long height; private Long height;
@Schema(
description = "实重重量,单位默认为克",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Long weight; private Long weight;
@Schema(
description = "包裹种类",
example = "1",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String packageType; private String packageType;
@Schema(
description = "运单号",
example = "P1234567",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String mailNo; private String mailNo;
@Schema(
description = "快递公司编号",
example = "SF",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String expressCode; private String expressCode;
} }
@Data @Data
public static class Result { public static class Result {
@Schema(
description = "异常原因",
example = "",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private String desc; private String desc;
@Schema(
description = "异常备注",
example = "",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private String remark; private String remark;
@Schema(
description = "异常编号",
example = "103",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private int code; private int code;
} }
......
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
import org.ta.pddserver.model.common.PageTool; import org.ta.pddserver.model.common.PageTool;
@Data @Data
public class PackageNoticeRequest extends PageTool { public class PackageNoticeRequest extends PageTool {
@Schema(
description = "搜索集运单号,模糊搜索",
example = "PC123456",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String orderCode; private String orderCode;
@Schema(
description = "订单状态,精准搜索",
example = "0",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private int status; private int status;
} }
package org.ta.pddserver.model.api.request; package org.ta.pddserver.model.api.request;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data; import lombok.Data;
@Data @Data
public class ReceiveRequest { public class ReceiveRequest {
@Schema(
description = "接口",
example = "warehouse_sign",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String action; private String action;
@Schema(
description = "运单号",
example = "P12345678",
defaultValue = "",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private String mailNo; private String mailNo;
private int status; // private int status;
@Schema(
description = "实操结果code",
example = "0",
defaultValue = "bizAction=(warehouse_sign、destroy)时填0;bizAction=warehouse_reject_sign时填非零错误码,具体编码见结果编码规范",
requiredMode = Schema.RequiredMode.REQUIRED // 必填
)
private Integer code; private Integer code;
private String desc; // private String desc;
//
private String remark; // private String remark;
@Schema(
description = "计费重量,单位默认为克",
example = "0",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private Long weight; private Long weight;
@Schema(
description = "包裹长度,单位默认为厘米",
example = "0",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private Long length; private Long length;
@Schema(
description = "包裹宽度,单位默认为厘米",
example = "0",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private Long width; private Long width;
@Schema(
description = "包裹高度,单位默认为厘米",
example = "0",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private Long height; private Long height;
@Schema(
description = "实际重量,单位默认为克",
example = "0",
defaultValue = "",
requiredMode = Schema.RequiredMode.NOT_REQUIRED // 必填
)
private Long actualWeight; private Long actualWeight;
} }
...@@ -4,7 +4,7 @@ spring: ...@@ -4,7 +4,7 @@ spring:
# url: jdbc:mysql://192.168.2.222:3306/pdd_api?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT # url: jdbc:mysql://192.168.2.222:3306/pdd_api?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT
# username: root # username: root
# password: root # password: root
url: jdbc:mysql://lyhj-mysql.mysql.rds.aliyuncs.com:3306/pdd_prod?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT url: jdbc:mysql://lyhj-mysql.mysql.rds.aliyuncs.com:3306/pdd_test?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT
username: pdd username: pdd
password: pdd123 password: pdd123
...@@ -21,7 +21,7 @@ spring: ...@@ -21,7 +21,7 @@ spring:
application: application:
name: PddServer name: PddServer
server: server:
port: 9000 port: 8600
logging: logging:
level: level:
org: org:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment