v1.0.0-feature: 增加swagger中文文档的支持

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/config/OpenApiConfig.java

@@ -49,4 +49,4 @@ public class OpenApiConfig {
                 .packagesToScan("com.sckw.payment.controller")
                 .build();
     }
-}
+}

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

@@ -12,6 +12,9 @@ import com.sckw.payment.request.KwpBizWalletPrepayRequest;
 import com.sckw.payment.request.KwpBizWalletQueryRequest;
 import com.sckw.payment.request.KwpBizWalletSaveRequest;
 import com.sckw.payment.service.wallet.KwpBizWalletService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import jakarta.servlet.http.HttpServletResponse;
 import lombok.RequiredArgsConstructor;
@@ -29,7 +32,7 @@ import java.util.List;
  * Des: 钱包管理Controller
  * Version: 1.0
  */
-
+@Tag(name = "钱包管理", description = "提供钱包相关操作接口")
 @RestController
 @RequestMapping("/biz/wallet")
 @RequiredArgsConstructor
@@ -41,9 +44,10 @@ public class KwpBizWalletController {
     /**
      * 分页查询钱包明细
      *
-     * @param request
-     * @return
+     * @param request 查询参数
+     * @return 钱包分页列表
      */
+    @Operation(summary = "分页查询钱包明细", description = "根据条件分页查询钱包明细信息")
     @GetMapping("/pageBizWalletList")
     public BaseResult<PageDataResult<KwpBizWalletPageResponse>> pageBizWalletList(@RequestBody KwpBizWalletQueryRequest request) {
         PageDataResult<KwpBizWalletPageResponse> WalletPageList = kwpBizWalletService.pageBizWalletList(request);
@@ -53,9 +57,10 @@ public class KwpBizWalletController {
     /**
      * 新增钱包
      *
-     * @param request
-     * @return
+     * @param request 钱包信息
+     * @return 操作结果
      */
+    @Operation(summary = "新增钱包", description = "新增一个钱包账户")
     @PostMapping("/addWallet")
     public BaseResult addWallet(@RequestBody @Validated KwpBizWalletSaveRequest request) {
         kwpBizWalletService.addWallet(request);
@@ -65,9 +70,11 @@ public class KwpBizWalletController {
     /**
      * 钱包状态更新
      *
-     * @param id
-     * @return
+     * @param id 钱包ID
+     * @return 操作结果
      */
+    @Operation(summary = "更新钱包状态", description = "根据ID更新钱包状态")
+    @Parameter(name = "id", description = "钱包ID", required = true)
     @PostMapping("/updateWallet")
     public BaseResult updateWallet(Long id) {
         kwpBizWalletService.updateWallet(id);
@@ -77,9 +84,10 @@ public class KwpBizWalletController {
     /**
      * 钱包金额更新
      *
-     * @param request
-     * @return
+     * @param request 钱包金额更新信息
+     * @return 操作结果
      */
+    @Operation(summary = "更新钱包金额", description = "更新钱包金额信息")
     @PostMapping("/updateWalletAmount")
     public BaseResult updateWalletAmount(@RequestBody @Validated KwpBizWalletPrepayRequest request) {
         kwpBizWalletService.updateWalletAmount(request);
@@ -89,9 +97,10 @@ public class KwpBizWalletController {
     /**
      * 钱包冻账明细
      *
-     * @param request
-     * @return
+     * @param request 查询参数
+     * @return 冻结明细分页列表
      */
+    @Operation(summary = "查询钱包冻结明细", description = "根据条件分页查询钱包冻结明细信息")
     @PostMapping("/walletPrepayDetail")
     public BaseResult<PageDataResult<KwpBizWalletPrepayPageResponse>> walletPrepayDetail(@RequestBody @Validated KwpBizWalletPrepayQueryRequest request) {
         PageDataResult<KwpBizWalletPrepayPageResponse> walletPrepayPageDataResult = kwpBizWalletService.walletPrepayDetail(request);
@@ -101,9 +110,11 @@ public class KwpBizWalletController {
     /**
      * 钱包冻账明细导出
      *
-     * @param request
-     * @return
+     * @param response HTTP响应
+     * @param request  查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出钱包冻结明细", description = "导出钱包冻结明细为Excel文件")
     @PostMapping("/exportWalletPrepay")
     public BaseResult exportWalletPrepay(@RequestBody @Validated HttpServletResponse response, KwpBizWalletPrepayQueryRequest request) {
         //查询导出数据
@@ -112,7 +123,4 @@ public class KwpBizWalletController {
         ExcelUtil.downData(response, KwpBizWalletPrepayExcelVO.class, excelVOList);
         return BaseResult.success();
     }
-
-
-
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/KwpLedgerLogisticsController.java

@@ -10,6 +10,9 @@ import com.sckw.payment.model.dto.LedgerLogisticsDto;
 import com.sckw.payment.model.vo.req.*;
 import com.sckw.payment.model.vo.res.LedgerLogisticsVo;
 import com.sckw.payment.service.KwpLedgerLogisticsService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -28,6 +31,7 @@ import java.util.stream.Collectors;
  *
  * @author xucaiqin
  */
+@Tag(name = "物流对账管理", description = "提供物流对账相关操作接口")
 @Validated
 @RestController
 @RequestMapping("/kwpLedgerLogistics")
@@ -39,8 +43,9 @@ public class KwpLedgerLogisticsController {
      * 物流对账单-发起对账(保存草稿)（承运方）
      *
      * @param logisticsReq 保存物流对账单参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账(保存草稿)", description = "物流对账单-发起对账(保存草稿)（承运方）")
     @RepeatSubmit(interval = 1000,message ="前方拥堵，请稍后尝试")
     @PostMapping("sendDraft")
     public HttpResult sendDraft(@RequestBody @Valid LogisticsSendReq logisticsReq) {
@@ -51,8 +56,9 @@ public class KwpLedgerLogisticsController {
      * 物流对账单-发起对账（承运方）
      *
      * @param logisticsReq 保存物流对账单参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账", description = "物流对账单-发起对账（承运方）")
     @PostMapping("send")
     @RepeatSubmit(interval = 1000,message ="前方拥堵，请稍后尝试")
     public HttpResult send(@RequestBody @Valid LogisticsSendReq logisticsReq) {
@@ -63,8 +69,9 @@ public class KwpLedgerLogisticsController {
      * 托运方物流对账单列表查询
      *
      * @param logisticsReq 物流订单查询参数
-     * @return
+     * @return 对账单列表
      */
+    @Operation(summary = "托运方物流对账单列表查询", description = "托运方物流对账单列表查询")
     @PostMapping("shipperList")
     public HttpResult shipperList(@RequestBody LogisticsReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.shipperList(logisticsReq));
@@ -74,8 +81,9 @@ public class KwpLedgerLogisticsController {
      * 托运方对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "托运方对账单关联订单", description = "托运方对账单关联订单")
     @GetMapping("shipperOrderList")
     public HttpResult shipperOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.orderList(ledgerListReq));
@@ -85,8 +93,9 @@ public class KwpLedgerLogisticsController {
      * 承运方物流对账单列表查询（物流公司、收钱方）
      *
      * @param logisticsReq 物流订单查询参数
-     * @return
+     * @return 对账单列表
      */
+    @Operation(summary = "承运方物流对账单列表查询", description = "承运方物流对账单列表查询（物流公司、收钱方）")
     @PostMapping("carrierList")
     public HttpResult carrierList(@RequestBody LogisticsReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.carrierList(logisticsReq));
@@ -96,8 +105,9 @@ public class KwpLedgerLogisticsController {
      * 承运方对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "承运方对账单关联订单", description = "承运方对账单关联订单")
     @GetMapping("carrierOrderList")
     public HttpResult carrierOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.orderList(ledgerListReq));
@@ -109,6 +119,8 @@ public class KwpLedgerLogisticsController {
      * @param id 物流对账单id
      * @return 物流对账单详情
      */
+    @Operation(summary = "承运方-查询物流对账单详情", description = "承运方-查询物流对账单详情")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryCarrierDetail")
     public HttpResult queryCarrierDetail(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryDetail(Long.valueOf(id), LogisticsUnitType.SHIPPER));
@@ -120,6 +132,8 @@ public class KwpLedgerLogisticsController {
      * @param id 物流对账单id
      * @return 物流对账单详情
      */
+    @Operation(summary = "托运方-查询物流对账单详情", description = "托运方-查询物流对账单详情")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryShipperDetail")
     public HttpResult queryDetail(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryDetail(Long.valueOf(id), LogisticsUnitType.CARRIER));
@@ -131,17 +145,20 @@ public class KwpLedgerLogisticsController {
      * @param id 物流对账单id
      * @return 物流对账单详情
      */
+    @Operation(summary = "修改物流对账单详情", description = "修改物流对账单详情（修改物流对账单接口使用） 仅发起对账方支持修改")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryUpdate")
     public HttpResult queryUpdate(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryUpdate(Long.valueOf(id)));
     }
 
     /**
-     * 托运方
+     * 托运方对账单统计
      *
      * @param logisticsReq 物流订单查询参数
      * @return 物流对账单统计数据
      */
+    @Operation(summary = "托运方对账单统计", description = "托运方对账单统计")
     @PostMapping("shipperCount")
     public HttpResult shipperCount(@RequestBody LogisticsReq logisticsReq) {
         logisticsReq.setUnitType(LogisticsUnitType.CARRIER);
@@ -155,11 +172,12 @@ public class KwpLedgerLogisticsController {
     }
 
     /**
-     * 承运方
+     * 承运方对账单统计
      *
      * @param logisticsReq 物流订单查询参数
      * @return 物流对账单统计数据
      */
+    @Operation(summary = "承运方对账单统计", description = "承运方对账单统计")
     @PostMapping("carrierCount")
     public HttpResult carrierCount(@RequestBody LogisticsReq logisticsReq) {
         logisticsReq.setUnitType(LogisticsUnitType.SHIPPER);
@@ -172,8 +190,10 @@ public class KwpLedgerLogisticsController {
      * 释放关联的订单（只有删除操作才释放订单）
      *
      * @param id 物流对账单id
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "删除对账单", description = "删除对账单，释放关联的订单（只有删除操作才释放订单）")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @DeleteMapping("delete")
     public HttpResult delete(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.remove(Long.valueOf(id)));
@@ -183,8 +203,10 @@ public class KwpLedgerLogisticsController {
      * 物流对账单-撤回对账
      *
      * @param id 物流对账单id
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "撤回对账", description = "物流对账单-撤回对账")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @PostMapping("back")
     public HttpResult back(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.backOrder(Long.valueOf(id)));
@@ -193,9 +215,10 @@ public class KwpLedgerLogisticsController {
     /**
      * 物流对账单-对账确认
      *
-     * @param confirmReq
-     * @return
+     * @param confirmReq 确认参数
+     * @return 操作结果
      */
+    @Operation(summary = "对账确认", description = "物流对账单-对账确认")
     @PostMapping("confirm")
     public HttpResult confirm(@RequestBody @Valid LedgerConfirmReq confirmReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.confirmOrder(confirmReq));
@@ -205,8 +228,10 @@ public class KwpLedgerLogisticsController {
      * 物流对账单-驳回查询
      *
      * @param id 物流对账单id
-     * @return
+     * @return 驳回信息
      */
+    @Operation(summary = "驳回查询", description = "物流对账单-驳回查询")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryBack")
     public HttpResult queryBack(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryBack(Long.valueOf(id)));
@@ -216,8 +241,9 @@ public class KwpLedgerLogisticsController {
      * 物流对账单-驳回
      *
      * @param ledgerReq 驳回参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "驳回对账单", description = "物流对账单-驳回")
     @PostMapping("doBack")
     public HttpResult doBack(@RequestBody @Valid LedgerReq ledgerReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.doBack(ledgerReq));
@@ -230,20 +256,22 @@ public class KwpLedgerLogisticsController {
      * </p>
      *
      * @param ledgerReq 对账完成参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "对账完成", description = "物流对账单-对账完成，生成结算单")
     @PostMapping("success")
     public HttpResult orderSuccess(@RequestBody @Valid LedgerSuccessReq ledgerReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.orderSuccess(ledgerReq));
     }
 
     /**
-     * 托运方-导出
+     * 托运方-导出对账单
      *
-     * @param response
-     * @param logisticsReq
-     * @return
+     * @param response HTTP响应
+     * @param logisticsReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "托运方-导出对账单", description = "托运方-导出")
     @PostMapping("exportShipper")
     public HttpResult exportShipper(HttpServletResponse response, @RequestBody LogisticsReq logisticsReq) {
         logisticsReq.setUnitType(LogisticsUnitType.CARRIER);
@@ -263,12 +291,13 @@ public class KwpLedgerLogisticsController {
     }
 
     /**
-     * 承运方
+     * 承运方-导出对账单
      *
-     * @param response
-     * @param logisticsReq
-     * @return
+     * @param response HTTP响应
+     * @param logisticsReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "承运方-导出对账单", description = "承运方-导出对账单")
     @PostMapping("exportCarrier")
     public HttpResult exportCarrier(HttpServletResponse response, @RequestBody LogisticsReq logisticsReq) {
         logisticsReq.setUnitType(LogisticsUnitType.SHIPPER);
@@ -286,4 +315,4 @@ public class KwpLedgerLogisticsController {
         ExcelUtil.downData(response, LedgerLogisticsVo.class, collect);
         return null;
     }
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/KwpLedgerTradeController.java

@@ -10,6 +10,9 @@ import com.sckw.payment.model.dto.LedgerTradeDto;
 import com.sckw.payment.model.vo.req.*;
 import com.sckw.payment.model.vo.res.LedgerTradeVo;
 import com.sckw.payment.service.KwpLedgerTradeService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -28,6 +31,7 @@ import java.util.stream.Collectors;
  *
  * @author xucaiqin
  */
+@Tag(name = "交易对账管理", description = "提供交易对账相关操作接口")
 @RestController
 @RequestMapping("/kwpLedgerTrade")
 @Validated
@@ -39,9 +43,10 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单-发起对账(保存草稿)
      *
-     * @param tradeSendReq
-     * @return
+     * @param tradeSendReq 对账单参数
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账(保存草稿)", description = "贸易对账单-发起对账(保存草稿)")
     @RepeatSubmit(interval = 1000,message ="前方拥堵，请稍后尝试")
     @PostMapping("sendDraft")
     public HttpResult sendDraft(@RequestBody @Valid TradeSendReq tradeSendReq) {
@@ -51,9 +56,10 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单-发起对账
      *
-     * @param tradeSendReq
-     * @return
+     * @param tradeSendReq 对账单参数
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账", description = "贸易对账单-发起对账")
     @RepeatSubmit(interval = 1000,message ="前方拥堵，请稍后尝试")
     @PostMapping("send")
     public HttpResult send(@RequestBody @Valid TradeSendReq tradeSendReq) {
@@ -63,9 +69,10 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单列表查询 销售方
      *
-     * @param tradeReq
-     * @return
+     * @param tradeReq 查询参数
+     * @return 对账单列表
      */
+    @Operation(summary = "销售方贸易对账单列表", description = "贸易对账单列表查询 销售方")
     @PostMapping("sellList")
     public HttpResult sellList(@RequestBody TradeReq tradeReq) {
         return HttpResult.ok(kwpLedgerTradeService.sellList(tradeReq));
@@ -75,8 +82,9 @@ public class KwpLedgerTradeController {
      * 销售方对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "销售方对账单关联订单", description = "销售方对账单关联订单")
     @GetMapping("sellOrderList")
     public HttpResult sellOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerTradeService.orderList(ledgerListReq));
@@ -85,9 +93,10 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单列表查询 采购方
      *
-     * @param tradeReq
-     * @return
+     * @param tradeReq 查询参数
+     * @return 对账单列表
      */
+    @Operation(summary = "采购方贸易对账单列表", description = "贸易对账单列表查询 采购方")
     @PostMapping("purchaseList")
     public HttpResult purchaseList(@RequestBody TradeReq tradeReq) {
         return HttpResult.ok(kwpLedgerTradeService.purchaseList(tradeReq));
@@ -97,8 +106,9 @@ public class KwpLedgerTradeController {
      * 对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "采购方对账单关联订单", description = "采购方对账单关联订单")
     @GetMapping("purchaseOrderList")
     public HttpResult purchaseOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerTradeService.orderList(ledgerListReq));
@@ -108,8 +118,10 @@ public class KwpLedgerTradeController {
      * 销售-查询贸易对账单详情
      *
      * @param id 对账单id
-     * @return
+     * @return 对账单详情
      */
+    @Operation(summary = "销售方贸易对账单详情", description = "销售-查询贸易对账单详情")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("querySellDetail")
     public HttpResult querySellDetail(@RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryDetail(Long.valueOf(id), TradeUnitType.PURCHASE));
@@ -118,9 +130,11 @@ public class KwpLedgerTradeController {
     /**
      * 采购-查询贸易对账单详情
      *
-     * @param id
-     * @return
+     * @param id 对账单id
+     * @return 对账单详情
      */
+    @Operation(summary = "采购方贸易对账单详情", description = "采购-查询贸易对账单详情")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("queryPurchaseDetail")
     public HttpResult queryPurchaseDetail(@RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryDetail(Long.valueOf(id), TradeUnitType.SELL));
@@ -129,19 +143,23 @@ public class KwpLedgerTradeController {
     /**
      * 修改贸易对账单详情（修改物流对账单接口使用）
      *
-     * @param id
-     * @return
+     * @param id 对账单id
+     * @return 对账单详情
      */
+    @Operation(summary = "修改贸易对账单详情", description = "修改贸易对账单详情（修改物流对账单接口使用）")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("queryUpdate")
     public HttpResult queryUpdate(@RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryUpdate(Long.valueOf(id)));
     }
 
     /**
-     * 贸易订单数分类统计
+     * 贸易订单数分类统计(销售方)
      *
-     * @return
+     * @param tradeReq 查询参数
+     * @return 统计结果
      */
+    @Operation(summary = "销售方贸易订单分类统计", description = "贸易订单数分类统计(销售方)")
     @PostMapping("sellCount")
     public HttpResult sellCount(@RequestBody TradeReq tradeReq) {
         tradeReq.setUnitType(TradeUnitType.PURCHASE);
@@ -150,10 +168,12 @@ public class KwpLedgerTradeController {
     }
 
     /**
-     * 贸易订单数分类统计
+     * 贸易订单数分类统计(采购方)
      *
-     * @return
+     * @param tradeReq 查询参数
+     * @return 统计结果
      */
+    @Operation(summary = "采购方贸易订单分类统计", description = "贸易订单数分类统计(采购方)")
     @PostMapping("purchaseCount")
     public HttpResult purchaseCount(@RequestBody TradeReq tradeReq) {
         tradeReq.setUnitType(TradeUnitType.SELL);
@@ -169,9 +189,11 @@ public class KwpLedgerTradeController {
     /**
      * 删除对账单
      *
-     * @param id
-     * @return
+     * @param id 对账单ID
+     * @return 操作结果
      */
+    @Operation(summary = "删除对账单", description = "删除对账单")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @DeleteMapping("delete")
     public HttpResult delete(@NotBlank(message = "id不能为空") String id) {
         return HttpResult.ok(kwpLedgerTradeService.remove(Long.valueOf(id)));
@@ -180,9 +202,11 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单-撤回对账
      *
-     * @param id
-     * @return
+     * @param id 对账单ID
+     * @return 操作结果
      */
+    @Operation(summary = "撤回对账", description = "贸易对账单-撤回对账")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @PostMapping("back")
     public HttpResult back(@NotBlank(message = "id不能为空") @RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.backOrder(Long.valueOf(id)));
@@ -191,9 +215,10 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单-对账确认
      *
-     * @param confirmReq
-     * @return
+     * @param confirmReq 确认参数
+     * @return 操作结果
      */
+    @Operation(summary = "对账确认", description = "贸易对账单-对账确认")
     @PostMapping("confirm")
     public HttpResult confirm(@RequestBody @Valid LedgerConfirmReq confirmReq) {
         return HttpResult.ok(kwpLedgerTradeService.confirmOrder(confirmReq));
@@ -202,9 +227,11 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单-驳回查询
      *
-     * @param id
-     * @return
+     * @param id 对账单ID
+     * @return 驳回信息
      */
+    @Operation(summary = "驳回查询", description = "贸易对账单-驳回查询")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("queryBack")
     public HttpResult queryBack(@NotBlank(message = "id不能为空") @RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryBack(Long.valueOf(id)));
@@ -213,9 +240,10 @@ public class KwpLedgerTradeController {
     /**
      * 贸易对账单-驳回对账
      *
-     * @param ledgerReq
-     * @return
+     * @param ledgerReq 驳回参数
+     * @return 操作结果
      */
+    @Operation(summary = "驳回对账", description = "贸易对账单-驳回对账")
     @PostMapping("doBack")
     public HttpResult doBack(@RequestBody @Valid LedgerReq ledgerReq) {
         return HttpResult.ok(kwpLedgerTradeService.doBack(ledgerReq));
@@ -227,21 +255,23 @@ public class KwpLedgerTradeController {
      * 生成结算单
      * </p>
      *
-     * @param ledgerReq
-     * @return
+     * @param ledgerReq 完成参数
+     * @return 操作结果
      */
+    @Operation(summary = "对账完成", description = "贸易对账单-对账完成，生成结算单")
     @PostMapping("success")
     public HttpResult orderSuccess(@RequestBody @Valid LedgerSuccessReq ledgerReq) {
         return HttpResult.ok(kwpLedgerTradeService.orderSuccess(ledgerReq));
     }
 
     /**
-     * 导出
+     * 导出销售方对账单
      *
-     * @param response
-     * @param tradeReq
-     * @return
+     * @param response HTTP响应
+     * @param tradeReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出销售方对账单", description = "导出销售方对账单")
     @PostMapping("sellExport")
     public HttpResult sellExport(HttpServletResponse response, @RequestBody TradeReq tradeReq) {
         tradeReq.setUnitType(TradeUnitType.PURCHASE);
@@ -260,12 +290,13 @@ public class KwpLedgerTradeController {
     }
 
     /**
-     * 导出
+     * 导出采购方对账单
      *
-     * @param response
-     * @param tradeReq
-     * @return
+     * @param response HTTP响应
+     * @param tradeReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出采购方对账单", description = "导出采购方对账单")
     @PostMapping("purchaseExport")
     public HttpResult purchaseExport(HttpServletResponse response, @RequestBody TradeReq tradeReq) {
         tradeReq.setUnitType(TradeUnitType.SELL);
@@ -282,4 +313,4 @@ public class KwpLedgerTradeController {
         ExcelUtil.downData(response, LedgerTradeVo.class, collect);
         return null;
     }
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/KwpSettlementLogisticsController.java

@@ -7,6 +7,9 @@ import com.sckw.payment.model.dto.SettlementLogisticsDto;
 import com.sckw.payment.model.vo.req.SettlementReq;
 import com.sckw.payment.model.vo.res.SettlementLogisticsVo;
 import com.sckw.payment.service.KwpSettlementLogisticsService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -24,21 +27,24 @@ import java.util.stream.Collectors;
  * @author Aick Spt
  * @date 2023-07-18 16:34
  */
+@Tag(name = "物流结算管理", description = "提供物流订单结算相关操作接口")
 @RestController
 @Slf4j
-@RequestMapping(name = "结算-物流运费订单", path = "/kwpSettlementLogistics")
+@RequestMapping(path = "/kwpSettlementLogistics")
 public class KwpSettlementLogisticsController {
 
     @Resource
     private KwpSettlementLogisticsService kwpSettlementLogisticsService;
 
     //   ========= 运费收款 承运方 =========
-    @PostMapping(name = "运费收款-物流订单列表", path = "pageListCollection")
+    @Operation(summary = "运费收款-物流订单列表", description = "查询运费收款的物流订单列表（承运方）")
+    @PostMapping(path = "pageListCollection")
     public HttpResult pageSelectCollection(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.pageSelectCollection(settlementReq));
     }
 
-    @PostMapping(name = "运费收款-物流订单各状态列表总数", path = "getCountListCollection")
+    @Operation(summary = "运费收款-物流订单各状态列表总数", description = "统计运费收款的物流订单各状态列表总数（承运方）")
+    @PostMapping(path = "getCountListCollection")
     public HttpResult getCountListCollection(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.getCountListCollection(settlementReq));
     }
@@ -46,11 +52,12 @@ public class KwpSettlementLogisticsController {
     /**
      * 承运方导出
      *
-     * @param response
-     * @param settlementReq
-     * @return
+     * @param response      HTTP响应
+     * @param settlementReq 查询参数
+     * @return 操作结果
      */
-    @PostMapping(name = "运费收款-根据条件导出物流订单表数据", path = "exportCollection")
+    @Operation(summary = "运费收款-导出物流订单表数据", description = "根据条件导出运费收款的物流订单表数据（承运方）")
+    @PostMapping(path = "exportCollection")
     public HttpResult exportCollection(HttpServletResponse response, @RequestBody @Valid SettlementReq settlementReq) {
         settlementReq.setUnitType(LogisticsUnitType.SHIPPER);
         settlementReq.setUnitTypeTwo(LogisticsUnitType.CARRIER);
@@ -59,19 +66,23 @@ public class KwpSettlementLogisticsController {
         return this.export(response, list);
     }
 
-    @GetMapping(name = "运费收款-物流订单详情", path = "detailCollection")
+    @Operation(summary = "运费收款-物流订单详情", description = "查询运费收款的物流订单详情（承运方）")
+    @Parameter(name = "id", description = "订单ID", required = true)
+    @GetMapping(path = "detailCollection")
     public HttpResult detailCollection(@RequestParam("id") Long id) {
         return HttpResult.ok(kwpSettlementLogisticsService.detailCollection(id));
     }
 
 
     //   ========= 运费付款 托运方 =========
-    @PostMapping(name = "运费付款-物流订单列表", path = "pageListPayment")
+    @Operation(summary = "运费付款-物流订单列表", description = "查询运费付款的物流订单列表（托运方）")
+    @PostMapping(path = "pageListPayment")
     public HttpResult pageSelectPayment(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.pageSelectPayment(settlementReq));
     }
 
-    @PostMapping(name = "运费付款-物流订单各状态列表总数", path = "getCountListPayment")
+    @Operation(summary = "运费付款-物流订单各状态列表总数", description = "统计运费付款的物流订单各状态列表总数（托运方）")
+    @PostMapping(path = "getCountListPayment")
     public HttpResult getCountListPayment(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.getCountListPayment(settlementReq));
     }
@@ -79,11 +90,12 @@ public class KwpSettlementLogisticsController {
     /**
      * 托运方导出
      *
-     * @param response
-     * @param settlementReq
-     * @return
+     * @param response      HTTP响应
+     * @param settlementReq 查询参数
+     * @return 操作结果
      */
-    @PostMapping(name = "运费付款-根据条件导出物流订单表数据", path = "exportPayment")
+    @Operation(summary = "运费付款-导出物流订单表数据", description = "根据条件导出运费付款的物流订单表数据（托运方）")
+    @PostMapping(path = "exportPayment")
     public HttpResult exportPayment(HttpServletResponse response, @RequestBody @Valid SettlementReq settlementReq) {
         settlementReq.setUnitType(LogisticsUnitType.CARRIER);
         settlementReq.setUnitTypeTwo(LogisticsUnitType.SHIPPER);
@@ -92,7 +104,9 @@ public class KwpSettlementLogisticsController {
         return this.export(response, list);
     }
 
-    @GetMapping(name = "物流订单详情", path = "detailPayment")
+    @Operation(summary = "物流订单详情", description = "查询物流订单详情（托运方）")
+    @Parameter(name = "id", description = "订单ID", required = true)
+    @GetMapping(path = "detailPayment")
     public HttpResult detailPayment(@RequestParam("id") Long id) {
         return HttpResult.ok(kwpSettlementLogisticsService.detailPayment(id));
     }
@@ -117,4 +131,4 @@ public class KwpSettlementLogisticsController {
     }
 
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/KwpSettlementOfflineController.java

@@ -7,6 +7,9 @@ import com.sckw.payment.model.vo.req.OfflinePaymentReq;
 import com.sckw.payment.model.vo.req.SettlementOfflinePayReq;
 import com.sckw.payment.model.vo.req.SettlementOfflineReq;
 import com.sckw.payment.service.KwpSettlementOfflineService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import org.springframework.web.bind.annotation.*;
@@ -17,8 +20,9 @@ import org.springframework.web.bind.annotation.*;
  * @author Aick Spt
  * @date 2023-07-20 11:42
  */
+@Tag(name = "线下结算管理", description = "提供线下结算记录相关操作接口")
 @RestController
-@RequestMapping(name = "结算-线下记录", path = "/kwpSettlementOffline")
+@RequestMapping(path = "/kwpSettlementOffline")
 public class KwpSettlementOfflineController {
 
     @Resource
@@ -26,18 +30,22 @@ public class KwpSettlementOfflineController {
 
     //  =========  运费收款  =========
 
-    @PostMapping(name = "物流-线下付款(运费收款)记录-列表", path = "pageListLogisticsCollection")
+    @Operation(summary = "物流-线下付款(运费收款)记录-列表", description = "查询物流订单线下付款(运费收款)记录列表")
+    @PostMapping(path = "pageListLogisticsCollection")
     public HttpResult pageListLogisticsCollection(@RequestBody @Valid SettlementOfflineReq settlementOfflineReq) {
         settlementOfflineReq.setOrderType(SettlementOrderTypeEnum.LOGISTICS.getStatus());
         return HttpResult.ok(kwpSettlementOfflineService.pageListLogisticsCollection(settlementOfflineReq));
     }
 
-    @GetMapping(name = "物流-线下付款(运费收款)记录-详情", path = "detailLogisticsCollection")
+    @Operation(summary = "物流-线下付款(运费收款)记录-详情", description = "查询物流订单线下付款(运费收款)记录详情")
+    @Parameter(name = "id", description = "记录ID", required = true)
+    @GetMapping(path = "detailLogisticsCollection")
     public HttpResult detailLogisticsCollection(@RequestParam("id") Long id) {
         return HttpResult.ok(kwpSettlementOfflineService.detailLogisticsCollection(id));
     }
 
-    @PostMapping(name = "物流-线下付款(运费收款)记录-新增", path = "confirmLogisticsCollection")
+    @Operation(summary = "物流-线下付款(运费收款)记录-新增", description = "新增物流订单线下付款(运费收款)记录")
+    @PostMapping(path = "confirmLogisticsCollection")
     public HttpResult confirmLogisticsCollection(@RequestBody @Valid OfflinePaymentReq offlinePaymentReq) {
         offlinePaymentReq.setOrderType(SettlementOrderTypeEnum.LOGISTICS.getStatus());
         return HttpResult.ok(kwpSettlementOfflineService.confirmLogisticsCollection(offlinePaymentReq));
@@ -49,10 +57,11 @@ public class KwpSettlementOfflineController {
     /**
      * 销售方-线下付款记录
      *
-     * @param settlementOfflineReq
-     * @return
+     * @param settlementOfflineReq 查询参数
+     * @return 付款记录列表
      */
-    @GetMapping(name = "交易-线下付款(销售收款)记录-列表", path = "pageListTrade")
+    @Operation(summary = "交易-线下付款(销售收款)记录-列表", description = "查询交易订单线下付款(销售收款)记录列表")
+    @GetMapping(path = "pageListTrade")
     public HttpResult pageListTradeCollection(@Valid SettlementOfflineReq settlementOfflineReq) {
         settlementOfflineReq.setOrderType(SettlementOrderTypeEnum.TRADE.getStatus());
         return HttpResult.ok(kwpSettlementOfflineService.pageListTradeCollection(settlementOfflineReq));
@@ -61,13 +70,14 @@ public class KwpSettlementOfflineController {
     /**
      * 销售收款-收款确认-线下付款
      *
-     * @param payReq
-     * @return
+     * @param payReq 付款参数
+     * @return 操作结果
      */
-    @PostMapping(name = "销售收款-收款确认-线下付款", path = "confirmTradeCollection")
+    @Operation(summary = "销售收款-收款确认-线下付款", description = "销售收款-收款确认-线下付款")
+    @PostMapping(path = "confirmTradeCollection")
     public HttpResult confirmTradeCollection(@Valid @RequestBody SettlementOfflinePayReq payReq) {
         payReq.setOrderType(SettlementOrderTypeEnum.TRADE.getStatus());
         return HttpResult.ok(kwpSettlementOfflineService.confirmTradeCollection(payReq));
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/KwpSettlementTradeController.java

@@ -7,6 +7,8 @@ import com.sckw.payment.model.constant.TradeUnitType;
 import com.sckw.payment.model.vo.req.SettlementTradeReq;
 import com.sckw.payment.model.vo.res.SettlementTradeVo;
 import com.sckw.payment.service.KwpSettlementTradeService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -23,8 +25,9 @@ import java.util.List;
  *
  * @author xucaiqin
  */
+@Tag(name = "交易结算管理", description = "提供交易订单结算相关操作接口")
 @RestController
-@RequestMapping(name = "结算-销售采购订单", path = "/kwpSettlementTrade")
+@RequestMapping(path = "/kwpSettlementTrade")
 public class KwpSettlementTradeController {
 
     @Resource
@@ -35,9 +38,10 @@ public class KwpSettlementTradeController {
     /**
      * 销售分页列表
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 结算单列表
      */
+    @Operation(summary = "销售结算单列表", description = "查询销售结算单分页列表")
     @PostMapping("pageSellList")
     public HttpResult pageListCollection(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.setUnitType(TradeUnitType.PURCHASE);
@@ -49,9 +53,10 @@ public class KwpSettlementTradeController {
     /**
      * 待结算、部分结算、全部结算
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 统计结果
      */
+    @Operation(summary = "销售结算单统计", description = "统计销售结算单状态（待结算、部分结算、全部结算）")
     @PostMapping("getSellCount")
     public HttpResult getCount(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.setUnitType(TradeUnitType.PURCHASE);
@@ -64,9 +69,10 @@ public class KwpSettlementTradeController {
     /**
      * 表尾金额结算数据
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 金额统计
      */
+    @Operation(summary = "销售结算金额统计", description = "统计销售结算单表尾金额结算数据")
     @PostMapping("getSellSum")
     public HttpResult getSellSum(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
@@ -79,10 +85,11 @@ public class KwpSettlementTradeController {
     /**
      * 导出销售结算单列表
      *
-     * @param response
-     * @param settlementReq
-     * @return
+     * @param response      HTTP响应
+     * @param settlementReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出销售结算单", description = "导出销售结算单列表")
     @PostMapping("exportCollection")
     public HttpResult exportCollection(HttpServletResponse response, @RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
@@ -99,9 +106,10 @@ public class KwpSettlementTradeController {
     /**
      * 采购分页列表
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 结算单列表
      */
+    @Operation(summary = "采购结算单列表", description = "查询采购结算单分页列表")
     @PostMapping("pagePurchaseList")
     public HttpResult pageListPayment(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
@@ -113,9 +121,10 @@ public class KwpSettlementTradeController {
     /**
      * 待结算、部分结算、全部结算
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 统计结果
      */
+    @Operation(summary = "采购结算单统计", description = "统计采购结算单状态（待结算、部分结算、全部结算）")
     @PostMapping("getPurchaseCount")
     public HttpResult getPurchaseCount(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
@@ -128,9 +137,10 @@ public class KwpSettlementTradeController {
     /**
      * 表尾金额结算数据
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 金额统计
      */
+    @Operation(summary = "采购结算金额统计", description = "统计采购结算单表尾金额结算数据")
     @PostMapping("getPurchaseSum")
     public HttpResult getCountListPayment(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
@@ -143,10 +153,11 @@ public class KwpSettlementTradeController {
     /**
      * 导出采购结算单列表
      *
-     * @param response
-     * @param settlementReq
-     * @return
+     * @param response      HTTP响应
+     * @param settlementReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出采购结算单", description = "导出采购结算单列表")
     @PostMapping("exportPayment")
     public HttpResult exportPayment(HttpServletResponse response, @RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
@@ -172,4 +183,4 @@ public class KwpSettlementTradeController {
     }
 
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/KwpSettlementWalletController.java

@@ -7,6 +7,9 @@ import com.sckw.payment.model.vo.req.OfflinePaymentReq;
 import com.sckw.payment.model.vo.req.SettlementWalletReq;
 import com.sckw.payment.model.vo.req.WalletPayReq;
 import com.sckw.payment.service.KwpSettlementWalletService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
@@ -19,9 +22,10 @@ import org.springframework.web.bind.annotation.*;
  * @author Aick Spt
  * @date 2023-07-20 14:42
  */
+@Tag(name = "电子钱包结算管理", description = "提供电子钱包结算记录相关操作接口")
 @Validated
 @RestController
-@RequestMapping(name = "结算-电子钱包结算记录", path = "/kwpSettlementWallet")
+@RequestMapping(path = "/kwpSettlementWallet")
 public class KwpSettlementWalletController {
 
     //  =========  物流付款  =========
@@ -29,7 +33,8 @@ public class KwpSettlementWalletController {
     @Resource
     private KwpSettlementWalletService kwpSettlementWalletService;
 
-    @PostMapping(name = "物流-电子钱包付款（货到付款）结算记录-列表", path = "pageListLogisticsPayment")
+    @Operation(summary = "物流-电子钱包付款（货到付款）结算记录-列表", description = "查询物流订单使用电子钱包付款（货到付款）的结算记录列表")
+    @PostMapping(path = "pageListLogisticsPayment")
     public HttpResult pageListLogisticsPayment(@RequestBody @Valid SettlementWalletReq settlementWalletReq) {
         settlementWalletReq.setPayType(SettlementWalletPayTypeEnum.CASH_ON_DELIVERY.getStatus());
         settlementWalletReq.setOrderType(SettlementOrderTypeEnum.LOGISTICS.getStatus());
@@ -46,7 +51,8 @@ public class KwpSettlementWalletController {
      * @author Aick Spt
      * @date 2023-07-25 09:55
      */
-    @PostMapping(name = "物流-电子钱包付款（货到付款）结算记录-新增", path = "confirmLogisticsPayment")
+    @Operation(summary = "物流-电子钱包付款（货到付款）结算记录-新增", description = "新增物流订单使用电子钱包付款（货到付款）的结算记录")
+    @PostMapping(path = "confirmLogisticsPayment")
     public HttpResult confirmLogisticsPayment(@RequestBody @Valid OfflinePaymentReq offlinePaymentReq) {
         return HttpResult.ok(kwpSettlementWalletService.confirmLogisticsPayment(offlinePaymentReq));
     }
@@ -59,7 +65,9 @@ public class KwpSettlementWalletController {
      * @author Aick Spt
      * @date 2023-08-16 11:15
      */
-    @GetMapping(name = "运费-货到付款-查询钱包余额", path = "getConfirmLogisticsPay")
+    @Operation(summary = "运费-货到付款-查询钱包余额", description = "运费-货到付款-查询钱包余额")
+    @Parameter(name = "id", description = "结算单ID", required = true)
+    @GetMapping(path = "getConfirmLogisticsPay")
     public HttpResult getConfirmLogisticsPay(@RequestParam("id") @NotBlank(message = "id不能为空") String id) {
         return HttpResult.ok(kwpSettlementWalletService.getConfirmLogisticsPayment(Long.parseLong(id)));
     }
@@ -70,10 +78,11 @@ public class KwpSettlementWalletController {
     /**
      * 采购付款记录-货到付款查询列表
      *
-     * @param settlementWalletReq
-     * @return
+     * @param settlementWalletReq 查询参数
+     * @return 付款记录列表
      */
-    @GetMapping(name = "销售-付款记录列表（采购电子钱包结算记录）", path = "pageListTradePayment")
+    @Operation(summary = "销售-付款记录列表（采购电子钱包结算记录）", description = "查询销售订单的付款记录列表（采购电子钱包结算记录）")
+    @GetMapping(path = "pageListTradePayment")
     public HttpResult pageListTradePayment(@Valid SettlementWalletReq settlementWalletReq) {
         settlementWalletReq.setPayType(SettlementWalletPayTypeEnum.CASH_ON_DELIVERY.getStatus());
         settlementWalletReq.setOrderType(SettlementOrderTypeEnum.TRADE.getStatus());
@@ -87,7 +96,9 @@ public class KwpSettlementWalletController {
      * @author Aick Spt
      * @date 2023-07-25 09:55
      */
-    @GetMapping(name = "采购-货到付款-查询钱包余额", path = "getConfirmPay")
+    @Operation(summary = "采购-货到付款-查询钱包余额", description = "采购订单货到付款时查询钱包余额")
+    @Parameter(name = "id", description = "结算单ID", required = true)
+    @GetMapping(path = "getConfirmPay")
     public HttpResult getConfirmPay(@RequestParam("id") @NotBlank(message = "id不能为空") String id) {
         return HttpResult.ok(kwpSettlementWalletService.getConfirmTradePayment(Long.parseLong(id)));
     }
@@ -95,7 +106,8 @@ public class KwpSettlementWalletController {
     /**
      * 采购-货到付款
      */
-    @PostMapping(name = "采购-付款确认-(新增电子钱包记录-采购货到付款)", path = "confirmReceive")
+    @Operation(summary = "采购-付款确认-(新增电子钱包记录-采购货到付款)", description = "采购订单货到付款确认，新增电子钱包记录")
+    @PostMapping(path = "confirmReceive")
     public HttpResult confirmTradePayment(@RequestBody @Valid WalletPayReq payReq) {
         return HttpResult.ok(kwpSettlementWalletService.confirmTradePayment(payReq));
     }
@@ -103,10 +115,11 @@ public class KwpSettlementWalletController {
     /**
      * 销售收款记录-预付款查询列表
      *
-     * @param settlementWalletReq
-     * @return
+     * @param settlementWalletReq 查询参数
+     * @return 收款记录列表
      */
-    @GetMapping(name = "销售-收款记录列表-预付款(电子钱包)", path = "pageListTradeCollection")
+    @Operation(summary = "销售-收款记录列表-预付款(电子钱包)", description = "查询销售订单的收款记录列表（预付款电子钱包）")
+    @GetMapping(path = "pageListTradeCollection")
     public HttpResult pageListTradeCollection(@Valid SettlementWalletReq settlementWalletReq) {
         settlementWalletReq.setPayType(SettlementWalletPayTypeEnum.ADVANCE_PAYMENT.getStatus());
         settlementWalletReq.setOrderType(SettlementOrderTypeEnum.TRADE.getStatus());
@@ -120,10 +133,12 @@ public class KwpSettlementWalletController {
      * @author Aick Spt
      * @date 2023-07-25 09:55
      */
-    @PostMapping(name = "销售-收款确认-预付款(电子钱包)", path = "confirmPrePay")
+    @Operation(summary = "销售-收款确认-预付款(电子钱包)", description = "销售订单收款确认，使用预付款(电子钱包)")
+    @Parameter(name = "id", description = "结算单ID", required = true)
+    @PostMapping(path = "confirmPrePay")
     public HttpResult confirmTradeCollection(@RequestParam("id") @NotBlank(message = "id不能为空") String id) {
         return HttpResult.ok(kwpSettlementWalletService.confirmTradeCollection(Long.parseLong(id)));
     }
 
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/WalletController.java

@@ -7,6 +7,9 @@ import com.sckw.payment.model.vo.req.page.MoneyPage;
 import com.sckw.payment.model.vo.req.page.PrePayPage;
 import com.sckw.payment.model.vo.req.page.RefundPage;
 import com.sckw.payment.service.WalletService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
@@ -20,6 +23,7 @@ import org.springframework.web.bind.annotation.*;
  * @author xucaiqin
  * @date 2023-08-28 15:36:48
  */
+@Tag(name = "钱包管理", description = "提供钱包相关操作接口")
 @Validated
 @RestController
 @RequestMapping("/wallet")
@@ -31,8 +35,10 @@ public class WalletController {
     /**
      * 开户
      *
-     * @return
+     * @param createUserReq 开户请求参数
+     * @return 操作结果
      */
+    @Operation(summary = "开户", description = "为用户开通钱包账户")
     @PostMapping("createUser")
     public HttpResult createUser(@RequestBody @Valid CreateUserReq createUserReq) {
         return HttpResult.ok(walletService.createUser(createUserReq));
@@ -41,10 +47,13 @@ public class WalletController {
     /**
      * 渠道用户开通信息
      *
-     * @param uid
-     * @param channel
-     * @return
+     * @param uid     用户ID
+     * @param channel 渠道
+     * @return 用户开通信息
      */
+    @Operation(summary = "查询渠道用户开通信息", description = "查询指定用户在指定渠道的开通信息")
+    @Parameter(name = "uid", description = "用户ID", required = true)
+    @Parameter(name = "channel", description = "渠道", required = true)
     @GetMapping("userInfo")
     public HttpResult userInfo(@NotBlank(message = "uid不能为空") @RequestParam("uid") String uid,
                                @NotBlank(message = "channel不能为空") @RequestParam("channel") String channel) {
@@ -54,8 +63,11 @@ public class WalletController {
     /**
      * 钱包总览信息
      *
-     * @return
+     * @param queryChannel 是否查询渠道信息
+     * @return 钱包总览信息
      */
+    @Operation(summary = "钱包总览信息", description = "获取当前用户的钱包总览信息")
+    @Parameter(name = "queryChannel", description = "是否查询渠道信息")
     @GetMapping("overview")
     public HttpResult overview(boolean queryChannel) {
         return HttpResult.ok(walletService.walletOverview(queryChannel));
@@ -64,8 +76,9 @@ public class WalletController {
     /**
      * 渠道开通情况
      *
-     * @return
+     * @return 渠道开通情况列表
      */
+    @Operation(summary = "渠道开通情况", description = "查询所有渠道的开通情况")
     @GetMapping("channel")
     public HttpResult channel() {
         return HttpResult.ok(walletService.channel());
@@ -74,8 +87,10 @@ public class WalletController {
     /**
      * 查询资金明细
      *
-     * @return
+     * @param walletDetailReq 查询参数
+     * @return 资金明细列表
      */
+    @Operation(summary = "查询资金明细", description = "根据条件查询资金明细")
     @GetMapping("detail")
     public HttpResult detail(WalletDetailReq walletDetailReq) {
         return HttpResult.ok(walletService.walletDetail(walletDetailReq));
@@ -84,8 +99,11 @@ public class WalletController {
     /**
      * 查询资金明细-按渠道统计数量
      *
-     * @return
+     * @param entName 企业名称
+     * @return 统计结果
      */
+    @Operation(summary = "资金明细按渠道统计", description = "按渠道统计资金明细数量")
+    @Parameter(name = "entName", description = "企业名称")
     @GetMapping("detailCount")
     public HttpResult count(String entName) {
         return HttpResult.ok(walletService.walletCount(entName));
@@ -94,9 +112,10 @@ public class WalletController {
     /**
      * 新增账目
      *
-     * @param addWalletReq
-     * @return
+     * @param addWalletReq 新增账目参数
+     * @return 操作结果
      */
+    @Operation(summary = "新增账目", description = "新增一笔账目")
     @PostMapping("add")
     public HttpResult add(@RequestBody @Valid AddWalletReq addWalletReq) {
         return HttpResult.ok(walletService.addWallet(addWalletReq));
@@ -105,9 +124,10 @@ public class WalletController {
     /**
      * 账目充值
      *
-     * @param addWalletReq
-     * @return
+     * @param addWalletReq 充值参数
+     * @return 操作结果
      */
+    @Operation(summary = "账目充值", description = "为账户充值")
     @PostMapping("recharge")
     public HttpResult recharge(@RequestBody @Valid WalletAppendReq addWalletReq) {
         return HttpResult.ok(walletService.addWalletMoney(addWalletReq));
@@ -116,9 +136,10 @@ public class WalletController {
     /**
      * 提现
      *
-     * @param cashWalletReq
-     * @return
+     * @param cashWalletReq 提现参数
+     * @return 操作结果
      */
+    @Operation(summary = "提现", description = "发起提现操作")
     @PostMapping("cashOUt")
     public HttpResult cashOUt(@RequestBody @Valid CashWalletReq cashWalletReq) {
         return HttpResult.ok(walletService.cashOUt(cashWalletReq));
@@ -127,9 +148,10 @@ public class WalletController {
     /**
      * 重新提现
      *
-     * @param cashWalletReq
-     * @return
+     * @param cashWalletReq 提现参数
+     * @return 操作结果
      */
+    @Operation(summary = "重新提现", description = "重新发起提现操作")
     @PostMapping("reCashOUt")
     public HttpResult reCashOUt(@RequestBody @Valid CashWalletReq cashWalletReq) {
         return HttpResult.ok(walletService.reCashOUt(cashWalletReq));
@@ -138,9 +160,10 @@ public class WalletController {
     /**
      * 转账
      *
-     * @param transferReq
-     * @return
+     * @param transferReq 转账参数
+     * @return 操作结果
      */
+    @Operation(summary = "转账", description = "发起转账操作")
     @PostMapping("transfer")
     public HttpResult transfer(@RequestBody @Valid TransferReq transferReq) {
         return HttpResult.ok(walletService.transfer(transferReq));
@@ -149,9 +172,10 @@ public class WalletController {
     /**
      * 提现记录
      *
-     * @param cashPageReq
-     * @return
+     * @param cashPageReq 查询参数
+     * @return 提现记录列表
      */
+    @Operation(summary = "提现记录", description = "查询提现记录")
     @GetMapping("cashList")
     public HttpResult cashList(CashPageReq cashPageReq) {
         return HttpResult.ok(walletService.cashList(cashPageReq));
@@ -160,9 +184,10 @@ public class WalletController {
     /**
      * 提现记录 分类统计
      *
-     * @param cashPageReq
-     * @return
+     * @param cashPageReq 查询参数
+     * @return 统计结果
      */
+    @Operation(summary = "提现记录分类统计", description = "对提现记录进行分类统计")
     @GetMapping("cashCount")
     public HttpResult cashCount(CashPageReq cashPageReq) {
         return HttpResult.ok(walletService.cashCount(cashPageReq));
@@ -171,9 +196,10 @@ public class WalletController {
     /**
      * 预付列表
      *
-     * @param prePayPage
-     * @return
+     * @param prePayPage 查询参数
+     * @return 预付列表
      */
+    @Operation(summary = "预付列表", description = "查询预付列表")
     @GetMapping("prePayList")
     public HttpResult prePayList(PrePayPage prePayPage) {
         return HttpResult.ok(walletService.prePayList(prePayPage));
@@ -183,8 +209,11 @@ public class WalletController {
     /**
      * 预付列表-按渠道统计数量
      *
-     * @return
+     * @param entName 企业名称
+     * @return 统计结果
      */
+    @Operation(summary = "预付列表按渠道统计", description = "预付列表-按渠道统计数量")
+    @Parameter(name = "entName", description = "企业名称")
     @GetMapping("prePayCount")
     public HttpResult prePayCount(String entName) {
         return HttpResult.ok(walletService.prePayCount(entName));
@@ -193,9 +222,10 @@ public class WalletController {
     /**
      * 预收列表
      *
-     * @param prePayPage
-     * @return
+     * @param prePayPage 查询参数
+     * @return 预收列表
      */
+    @Operation(summary = "预收列表", description = "查询预收列表")
     @GetMapping("preReceiveList")
     public HttpResult preReceiveList(PrePayPage prePayPage) {
         return HttpResult.ok(walletService.preReceiveList(prePayPage));
@@ -204,8 +234,11 @@ public class WalletController {
     /**
      * 预收列表-按渠道统计数量
      *
-     * @return
+     * @param entName 企业名称
+     * @return 统计结果
      */
+    @Operation(summary = "预收列表按渠道统计", description = "预收列表-按渠道统计数量")
+    @Parameter(name = "entName", description = "企业名称")
     @GetMapping("preReceiveCount")
     public HttpResult preReceiveCount(String entName) {
         return HttpResult.ok(walletService.preReceiveCount(entName));
@@ -214,9 +247,10 @@ public class WalletController {
     /**
      * 预付校验
      *
-     * @param prePayCheck
-     * @return
+     * @param prePayCheck 校验参数
+     * @return 校验结果
      */
+    @Operation(summary = "预付校验", description = "预付操作前的校验")
     @PostMapping("prePayCheck")
     public HttpResult prePayCheck(@RequestBody @Valid PrePayCheck prePayCheck) {
         return HttpResult.ok(walletService.prePayCheck(prePayCheck));
@@ -225,19 +259,22 @@ public class WalletController {
     /**
      * 新增预付
      *
-     * @param prePay
-     * @return
+     * @param prePay 预付参数
+     * @return 操作结果
      */
+    @Operation(summary = "新增预付", description = "新增一笔预付")
     @PostMapping("addPrePay")
     public HttpResult addPrePay(@RequestBody @Valid PrePay prePay) {
         return HttpResult.ok(walletService.addPrePay(prePay));
     }
 
     /**
+     * 处理查询
      *
-     * @param operateReq
-     * @return
+     * @param operateReq 查询参数
+     * @return 查询结果
      */
+    @Operation(summary = "处理查询", description = "查询处理信息")
     @PostMapping("dealQuery")
     public HttpResult dealQuery(@RequestBody @Valid OperateReq operateReq) {
         return HttpResult.ok(walletService.dealQuery(operateReq));
@@ -245,9 +282,10 @@ public class WalletController {
 
     /**
      * 提现确认
-     * @param cashCheck
-     * @return
+     * @param cashCheck 提现确认参数
+     * @return 操作结果
      */
+    @Operation(summary = "提现确认", description = "确认提现操作")
     @PostMapping("cashCheck")
     public HttpResult cashCheck(@RequestBody @Valid CashCheck cashCheck) {
         return HttpResult.ok(walletService.cashCheck(cashCheck));
@@ -256,9 +294,10 @@ public class WalletController {
     /**
      * 预付追加校验
      *
-     * @param appendPayCheck
-     * @return
+     * @param appendPayCheck 校验参数
+     * @return 校验结果
      */
+    @Operation(summary = "预付追加校验", description = "预付追加操作前的校验")
     @PostMapping("appendCheck")
     public HttpResult prePayAppendCheck(@RequestBody @Valid AppendPayCheck appendPayCheck) {
         return HttpResult.ok(walletService.appendCheck(appendPayCheck));
@@ -267,9 +306,10 @@ public class WalletController {
     /**
      * 预付追加
      *
-     * @param prePay
-     * @return
+     * @param prePay 追加参数
+     * @return 操作结果
      */
+    @Operation(summary = "预付追加", description = "追加预付金额")
     @PostMapping("prePayAppend")
     public HttpResult prePayAppend(@RequestBody @Valid PrePayAppend prePay) {
         return HttpResult.ok(walletService.prePayAppend(prePay));
@@ -281,9 +321,10 @@ public class WalletController {
     /**
      * 申请退款(预付方)
      *
-     * @param refundReq
-     * @return
+     * @param refundReq 退款参数
+     * @return 操作结果
      */
+    @Operation(summary = "申请退款", description = "申请退款(预付方)")
     @PostMapping("applyRefund")
     public HttpResult applyRefund(@RequestBody @Valid ApplyRefundReq refundReq) {
         return HttpResult.ok(walletService.applyRefund(refundReq));
@@ -293,9 +334,10 @@ public class WalletController {
     /**
      * 查询退款列表(预收方)
      *
-     * @param refundPage
-     * @return
+     * @param refundPage 查询参数
+     * @return 退款列表
      */
+    @Operation(summary = "查询退款列表", description = "查询退款列表(预收方)")
     @PostMapping("refundList")
     public HttpResult refundList(@RequestBody @Valid RefundPage refundPage) {
         return HttpResult.ok(walletService.refundList(refundPage));
@@ -306,8 +348,9 @@ public class WalletController {
      * 发起退款（预收方）余额查询及校验
      *
      * @param id 退款单id
-     * @return
+     * @return 校验结果
      */
+    @Operation(summary = "发起退款校验", description = "发起退款（预收方）余额查询及校验")
     @PostMapping("refundCheck")
     public HttpResult refundCheck(@RequestBody @Valid Id id) {
         return HttpResult.ok(walletService.refundCheck(id.getIdLong()));
@@ -316,9 +359,10 @@ public class WalletController {
     /**
      * 确认退款
      *
-     * @param refundReq
-     * @return
+     * @param refundReq 退款参数
+     * @return 操作结果
      */
+    @Operation(summary = "确认退款", description = "确认退款操作")
     @PostMapping("refund")
     public HttpResult refund(@RequestBody @Valid RefundReq refundReq) {
         return HttpResult.ok(walletService.launchRefund(refundReq));
@@ -327,9 +371,10 @@ public class WalletController {
     /**
      * 驳回退款
      *
-     * @param refundReq
-     * @return
+     * @param refundReq 驳回参数
+     * @return 操作结果
      */
+    @Operation(summary = "驳回退款", description = "驳回退款申请")
     @PostMapping("backRefund")
     public HttpResult back(@RequestBody @Valid RefundBackReq refundReq) {
         return HttpResult.ok(walletService.backRefund(refundReq));
@@ -342,9 +387,10 @@ public class WalletController {
     /**
      * 充值订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 充值订单列表
      */
+    @Operation(summary = "充值订单", description = "查询充值订单列表")
     @PostMapping("rechargeOrder")
     public HttpResult rechargeList(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.rechargeList(moneyPage));
@@ -353,9 +399,10 @@ public class WalletController {
     /**
      * 转账订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 转账订单列表
      */
+    @Operation(summary = "转账订单", description = "查询转账订单列表")
     @PostMapping("transferOrder")
     public HttpResult transferList(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.transferOrder(moneyPage));
@@ -364,9 +411,10 @@ public class WalletController {
     /**
      * 货到付款订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 货到付款订单列表
      */
+    @Operation(summary = "货到付款订单", description = "查询货到付款订单列表")
     @PostMapping("receiveOrder")
     public HttpResult receiveOrder(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.transferReceiveOrder(moneyPage));
@@ -375,9 +423,10 @@ public class WalletController {
     /**
      * 退款订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 退款订单列表
      */
+    @Operation(summary = "退款订单", description = "查询退款订单列表")
     @PostMapping("refundOrder")
     public HttpResult refundOrder(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.refundOrder(moneyPage));
@@ -386,9 +435,10 @@ public class WalletController {
     /**
      * 提现订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 提现订单列表
      */
+    @Operation(summary = "提现订单", description = "查询提现订单列表")
     @PostMapping("cashOrder")
     public HttpResult cashOrder(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.cashOrder(moneyPage));
@@ -397,11 +447,12 @@ public class WalletController {
     /*提现-详细记录*/
 
     /**
-     * 提现
+     * 提现详情
      *
-     * @param cashDetailReq
-     * @return
+     * @param cashDetailReq 查询参数
+     * @return 提现详情
      */
+    @Operation(summary = "提现详情", description = "查询提现详情")
     @PostMapping("cashDetail")
     public HttpResult cashDetail(@RequestBody @Valid CashDetailReq cashDetailReq) {
         return HttpResult.ok(walletService.cashDetail(cashDetailReq));
@@ -411,9 +462,10 @@ public class WalletController {
     /**
      * 预付订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 预付订单列表
      */
+    @Operation(summary = "预付订单", description = "查询预付订单列表")
     @PostMapping("prePayOrder")
     public HttpResult prePayOrder(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.prePayOrder(moneyPage));
@@ -422,9 +474,10 @@ public class WalletController {
     /**
      * 退款记录
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 退款记录列表
      */
+    @Operation(summary = "预付退款记录", description = "查询预付退款记录")
     @PostMapping("prePayRefund")
     public HttpResult prePayRefund(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.prePayRefund(moneyPage));
@@ -433,9 +486,10 @@ public class WalletController {
     /**
      * 预付消费日志
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 消费日志列表
      */
+    @Operation(summary = "预付消费日志", description = "查询预付消费日志")
     @GetMapping("prePayLogs")
     public HttpResult prePayLogs(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.prePayLogs(moneyPage));
@@ -445,9 +499,10 @@ public class WalletController {
     /**
      * 预收订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 预收订单列表
      */
+    @Operation(summary = "预收订单", description = "查询预收订单列表")
     @PostMapping("preReceiveOrder")
     public HttpResult preReceiveOrder(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.preReceiveOrder(moneyPage));
@@ -456,11 +511,12 @@ public class WalletController {
     /**
      * 退款订单
      *
-     * @param moneyPage
-     * @return
+     * @param moneyPage 查询参数
+     * @return 退款订单列表
      */
+    @Operation(summary = "预收退款订单", description = "查询预收退款订单")
     @PostMapping("preReceiveRefund")
     public HttpResult preReceiveRefund(@RequestBody @Valid MoneyPage moneyPage) {
         return HttpResult.ok(walletService.preReceiveRefund(moneyPage));
     }
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/WorkbenchController.java

@@ -3,6 +3,8 @@ package com.sckw.payment.controller;
 import com.sckw.core.web.response.HttpResult;
 import com.sckw.payment.model.vo.req.FinanceCount;
 import com.sckw.payment.service.WorkbenchService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import lombok.extern.slf4j.Slf4j;
@@ -15,6 +17,7 @@ import org.springframework.web.bind.annotation.*;
  * @author xucaiqin
  * @date 2023-08-28 15:36:48
  */
+@Tag(name = "工作台", description = "提供工作台相关数据接口")
 @Validated
 @RestController
 @RequestMapping("/workbench")
@@ -24,13 +27,15 @@ public class WorkbenchController {
     private WorkbenchService workbenchService;
 
     /**
-     * 财务数据
+     * 财务数据统计
      *
-     * @return
+     * @param financeCount 财务统计参数
+     * @return 财务统计数据
      */
+    @Operation(summary = "财务数据统计", description = "根据条件统计财务数据")
     @PostMapping("finance")
     public HttpResult finance(@Valid @RequestBody FinanceCount financeCount) {
         return HttpResult.ok(workbenchService.financeCount(financeCount));
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/app/AppKwpLedgerLogisticsController.java

@@ -7,6 +7,9 @@ import com.sckw.payment.model.constant.LogisticsUnitType;
 import com.sckw.payment.model.dto.Id;
 import com.sckw.payment.model.vo.req.*;
 import com.sckw.payment.service.KwpLedgerLogisticsService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
@@ -22,6 +25,7 @@ import java.util.stream.Collectors;
  *
  * @author xucaiqin
  */
+@Tag(name = "App物流对账管理", description = "提供App端物流对账相关操作接口")
 @Validated
 @RestController
 @RequestMapping("/appKwpLedgerLogistics")
@@ -33,8 +37,9 @@ public class AppKwpLedgerLogisticsController {
      * 物流对账单-发起对账(保存草稿)（承运方）
      *
      * @param logisticsReq 保存物流对账单参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账(保存草稿)", description = "物流对账单-发起对账(保存草稿)（承运方）")
     @PostMapping("sendDraft")
     public HttpResult sendDraft(@RequestBody @Valid LogisticsSendReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.sendLedgerDraft(logisticsReq));
@@ -44,8 +49,9 @@ public class AppKwpLedgerLogisticsController {
      * 物流对账单-发起对账（承运方）
      *
      * @param logisticsReq 保存物流对账单参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账", description = "物流对账单-发起对账（承运方）")
     @PostMapping("send")
     public HttpResult send(@RequestBody @Valid LogisticsSendReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.sendLedger(logisticsReq));
@@ -55,8 +61,9 @@ public class AppKwpLedgerLogisticsController {
      * 托运方物流对账单列表查询
      *
      * @param logisticsReq 物流订单查询参数
-     * @return
+     * @return 对账单列表
      */
+    @Operation(summary = "托运方物流对账单列表", description = "托运方物流对账单列表查询")
     @PostMapping("shipperList")
     public HttpResult shipperList(@RequestBody @Valid LogisticsReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.shipperList(logisticsReq));
@@ -68,6 +75,7 @@ public class AppKwpLedgerLogisticsController {
      * @param logisticsReq 物流订单查询参数
      * @return 对账单梳理、对账单金额
      */
+    @Operation(summary = "托运方物流对账单统计", description = "托运方物流对账单统计")
     @PostMapping("shipperSum")
     public HttpResult shipperSum(@RequestBody @Valid LogisticsReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.shipperSum(logisticsReq));
@@ -77,8 +85,9 @@ public class AppKwpLedgerLogisticsController {
      * 托运方对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "托运方对账单关联订单", description = "托运方对账单关联订单")
     @GetMapping("shipperOrderList")
     public HttpResult shipperOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryOrderList(ledgerListReq));
@@ -88,8 +97,9 @@ public class AppKwpLedgerLogisticsController {
      * 承运方物流对账单列表查询（物流公司、收钱方）
      *
      * @param logisticsReq 物流订单查询参数
-     * @return
+     * @return 对账单列表
      */
+    @Operation(summary = "承运方物流对账单列表", description = "承运方物流对账单列表查询（物流公司、收钱方）")
     @PostMapping("carrierList")
     public HttpResult carrierList(@RequestBody @Valid LogisticsReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.carrierList(logisticsReq));
@@ -99,9 +109,10 @@ public class AppKwpLedgerLogisticsController {
     /**
      * 承运方物流对账单统计
      *
-     * @param logisticsReq
+     * @param logisticsReq 查询参数
      * @return 对账应收金额、对账单数量
      */
+    @Operation(summary = "承运方物流对账单统计", description = "承运方物流对账单统计")
     @PostMapping("carrierSum")
     public HttpResult carrierSum(@RequestBody @Valid LogisticsReq logisticsReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.carrierSumCount(logisticsReq));
@@ -111,8 +122,9 @@ public class AppKwpLedgerLogisticsController {
      * 承运方对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "承运方对账单关联订单", description = "承运方对账单关联订单")
     @GetMapping("carrierOrderList")
     public HttpResult carrierOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryOrderList(ledgerListReq));
@@ -124,6 +136,8 @@ public class AppKwpLedgerLogisticsController {
      * @param id 物流对账单id
      * @return 物流对账单详情
      */
+    @Operation(summary = "承运方-查询物流对账单详情", description = "承运方-查询物流对账单详情")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryCarrierDetail")
     public HttpResult queryCarrierDetail(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryDetail(Long.valueOf(id), LogisticsUnitType.SHIPPER));
@@ -135,6 +149,8 @@ public class AppKwpLedgerLogisticsController {
      * @param id 物流对账单id
      * @return 物流对账单详情
      */
+    @Operation(summary = "托运方-查询物流对账单详情", description = "托运方-查询物流对账单详情")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryShipperDetail")
     public HttpResult queryDetail(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryDetail(Long.valueOf(id), LogisticsUnitType.CARRIER));
@@ -146,17 +162,20 @@ public class AppKwpLedgerLogisticsController {
      * @param id 物流对账单id
      * @return 物流对账单详情
      */
+    @Operation(summary = "修改物流对账单详情", description = "修改物流对账单详情（修改物流对账单接口使用） 仅发起对账方支持修改")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryUpdate")
     public HttpResult queryUpdate(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryUpdate(Long.valueOf(id)));
     }
 
     /**
-     * 托运方
+     * 托运方对账单统计
      *
      * @param logisticsReq 物流订单查询参数
      * @return 物流对账单统计数据
      */
+    @Operation(summary = "托运方对账单统计", description = "托运方物流对账单统计数据")
     @PostMapping("shipperCount")
     public HttpResult shipperCount(@RequestBody @Valid LogisticsReq logisticsReq) {
         logisticsReq.setUnitType(LogisticsUnitType.CARRIER);
@@ -170,11 +189,12 @@ public class AppKwpLedgerLogisticsController {
     }
 
     /**
-     * 承运方
+     * 承运方对账单统计
      *
      * @param logisticsReq 物流订单查询参数
      * @return 物流对账单统计数据
      */
+    @Operation(summary = "承运方对账单统计", description = "承运方物流对账单统计数据")
     @PostMapping("carrierCount")
     public HttpResult carrierCount(@RequestBody @Valid LogisticsReq logisticsReq) {
         logisticsReq.setUnitType(LogisticsUnitType.SHIPPER);
@@ -187,8 +207,9 @@ public class AppKwpLedgerLogisticsController {
      * 释放关联的订单（只有删除操作才释放订单）
      *
      * @param id 物流对账单id
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "删除对账单", description = "删除对账单，释放关联的订单（只有删除操作才释放订单）")
     @DeleteMapping("delete")
     public HttpResult delete(@RequestBody @Valid Id id) {
         return HttpResult.ok(kwpLedgerLogisticsService.remove(id.getIdLong()));
@@ -198,8 +219,10 @@ public class AppKwpLedgerLogisticsController {
      * 物流对账单-撤回对账
      *
      * @param id 物流对账单id
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "撤回对账", description = "物流对账单-撤回对账")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @PostMapping("back")
     public HttpResult back(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.backOrder(Long.valueOf(id)));
@@ -208,9 +231,10 @@ public class AppKwpLedgerLogisticsController {
     /**
      * 物流对账单-对账确认
      *
-     * @param confirmReq
-     * @return
+     * @param confirmReq 确认参数
+     * @return 操作结果
      */
+    @Operation(summary = "对账确认", description = "物流对账单-对账确认")
     @PostMapping("confirm")
     public HttpResult confirm(@RequestBody @Valid LedgerConfirmReq confirmReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.confirmOrder(confirmReq));
@@ -220,8 +244,10 @@ public class AppKwpLedgerLogisticsController {
      * 物流对账单-驳回查询
      *
      * @param id 物流对账单id
-     * @return
+     * @return 驳回信息
      */
+    @Operation(summary = "驳回查询", description = "物流对账单-驳回查询")
+    @Parameter(name = "id", description = "物流对账单id", required = true)
     @GetMapping("queryBack")
     public HttpResult queryBack(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(kwpLedgerLogisticsService.queryBack(Long.valueOf(id)));
@@ -231,8 +257,9 @@ public class AppKwpLedgerLogisticsController {
      * 物流对账单-驳回
      *
      * @param ledgerReq 驳回参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "驳回对账单", description = "物流对账单-驳回")
     @PostMapping("doBack")
     public HttpResult doBack(@RequestBody @Valid LedgerReq ledgerReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.doBack(ledgerReq));
@@ -245,10 +272,11 @@ public class AppKwpLedgerLogisticsController {
      * </p>
      *
      * @param ledgerReq 对账完成参数
-     * @return
+     * @return 操作结果
      */
+    @Operation(summary = "对账完成", description = "物流对账单-对账完成，生成结算单")
     @PostMapping("success")
     public HttpResult orderSuccess(@RequestBody @Valid LedgerSuccessReq ledgerReq) {
         return HttpResult.ok(kwpLedgerLogisticsService.orderSuccess(ledgerReq));
     }
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/app/AppKwpLedgerTradeController.java

@@ -5,6 +5,9 @@ import com.sckw.payment.model.constant.TradeUnitType;
 import com.sckw.payment.model.dto.Id;
 import com.sckw.payment.model.vo.req.*;
 import com.sckw.payment.service.KwpLedgerTradeService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
@@ -17,6 +20,7 @@ import org.springframework.web.bind.annotation.*;
  *
  * @author xucaiqin
  */
+@Tag(name = "App交易对账管理", description = "提供App端交易对账相关操作接口")
 @RestController
 @RequestMapping("/appKwpLedgerTrade")
 @Validated
@@ -28,9 +32,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单-发起对账(保存草稿)
      *
-     * @param tradeSendReq
-     * @return
+     * @param tradeSendReq 对账单参数
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账(保存草稿)", description = "贸易对账单-发起对账(保存草稿)")
     @PostMapping("sendDraft")
     public HttpResult sendDraft(@RequestBody @Valid TradeSendReq tradeSendReq) {
         return HttpResult.ok(kwpLedgerTradeService.sendLedgerDraft(tradeSendReq));
@@ -39,9 +44,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单-发起对账
      *
-     * @param tradeSendReq
-     * @return
+     * @param tradeSendReq 对账单参数
+     * @return 操作结果
      */
+    @Operation(summary = "发起对账", description = "贸易对账单-发起对账")
     @PostMapping("send")
     public HttpResult send(@RequestBody @Valid TradeSendReq tradeSendReq) {
         return HttpResult.ok(kwpLedgerTradeService.sendLedger(tradeSendReq));
@@ -50,9 +56,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单列表查询 销售方
      *
-     * @param tradeReq
-     * @return
+     * @param tradeReq 查询参数
+     * @return 对账单列表
      */
+    @Operation(summary = "销售方贸易对账单列表", description = "贸易对账单列表查询 销售方")
     @PostMapping("sellList")
     public HttpResult sellList(@RequestBody @Valid TradeReq tradeReq) {
         return HttpResult.ok(kwpLedgerTradeService.sellList(tradeReq));
@@ -61,9 +68,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单统计数据 销售方
      *
-     * @param tradeReq
-     * @return
+     * @param tradeReq 查询参数
+     * @return 统计数据
      */
+    @Operation(summary = "销售方贸易对账单统计", description = "贸易对账单统计数据 销售方")
     @PostMapping("sellSum")
     public HttpResult sellSum(@RequestBody @Valid TradeReq tradeReq) {
         return HttpResult.ok(kwpLedgerTradeService.sellSum(tradeReq));
@@ -73,8 +81,9 @@ public class AppKwpLedgerTradeController {
      * 销售方对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "销售方对账单关联订单", description = "销售方对账单关联订单")
     @GetMapping("sellOrderList")
     public HttpResult sellOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerTradeService.queryOrderList(ledgerListReq));
@@ -83,9 +92,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单列表查询 采购方
      *
-     * @param tradeReq
-     * @return
+     * @param tradeReq 查询参数
+     * @return 对账单列表
      */
+    @Operation(summary = "采购方贸易对账单列表", description = "贸易对账单列表查询 采购方")
     @PostMapping("purchaseList")
     public HttpResult purchaseList(@RequestBody @Valid TradeReq tradeReq) {
         return HttpResult.ok(kwpLedgerTradeService.purchaseList(tradeReq));
@@ -94,9 +104,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单统计 采购方
      *
-     * @param tradeReq
-     * @return
+     * @param tradeReq 查询参数
+     * @return 统计数据
      */
+    @Operation(summary = "采购方贸易对账单统计", description = "贸易对账单统计 采购方")
     @PostMapping("purchaseSum")
     public HttpResult purchaseSum(@RequestBody @Valid TradeReq tradeReq) {
         return HttpResult.ok(kwpLedgerTradeService.purchaseSum(tradeReq));
@@ -106,8 +117,9 @@ public class AppKwpLedgerTradeController {
      * 对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "采购方对账单关联订单", description = "采购方对账单关联订单")
     @GetMapping("purchaseOrderList")
     public HttpResult purchaseOrderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(kwpLedgerTradeService.queryOrderList(ledgerListReq));
@@ -117,8 +129,10 @@ public class AppKwpLedgerTradeController {
      * 销售-查询贸易对账单详情
      *
      * @param id 对账单id
-     * @return
+     * @return 对账单详情
      */
+    @Operation(summary = "销售方贸易对账单详情", description = "销售-查询贸易对账单详情")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("querySellDetail")
     public HttpResult querySellDetail(@NotBlank(message = "id不能为空") @RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryDetail(Long.valueOf(id), TradeUnitType.PURCHASE));
@@ -127,9 +141,11 @@ public class AppKwpLedgerTradeController {
     /**
      * 采购-查询贸易对账单详情
      *
-     * @param id
-     * @return
+     * @param id 对账单id
+     * @return 对账单详情
      */
+    @Operation(summary = "采购方贸易对账单详情", description = "采购-查询贸易对账单详情")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("queryPurchaseDetail")
     public HttpResult queryPurchaseDetail(@NotBlank(message = "id不能为空") @RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryDetail(Long.valueOf(id), TradeUnitType.SELL));
@@ -139,8 +155,10 @@ public class AppKwpLedgerTradeController {
      * 修改贸易对账单详情（修改物流对账单接口使用）
      *
      * @param id 对账单id
-     * @return
+     * @return 对账单详情
      */
+    @Operation(summary = "修改贸易对账单详情", description = "修改贸易对账单详情（修改物流对账单接口使用）")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("queryUpdate")
     public HttpResult queryUpdate(@NotBlank(message = "id不能为空") @RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryUpdate(Long.valueOf(id)));
@@ -150,9 +168,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 删除对账单
      *
-     * @param id
-     * @return
+     * @param id 对账单ID
+     * @return 操作结果
      */
+    @Operation(summary = "删除对账单", description = "删除对账单")
     @DeleteMapping("delete")
     public HttpResult delete(@RequestBody @Valid Id id) {
         return HttpResult.ok(kwpLedgerTradeService.remove(id.getIdLong()));
@@ -161,9 +180,11 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单-撤回对账
      *
-     * @param id
-     * @return
+     * @param id 对账单ID
+     * @return 操作结果
      */
+    @Operation(summary = "撤回对账", description = "贸易对账单-撤回对账")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @PostMapping("back")
     public HttpResult back(@NotBlank(message = "id不能为空") @RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.backOrder(Long.valueOf(id)));
@@ -172,9 +193,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单-对账确认
      *
-     * @param confirmReq
-     * @return
+     * @param confirmReq 确认参数
+     * @return 操作结果
      */
+    @Operation(summary = "对账确认", description = "贸易对账单-对账确认")
     @PostMapping("confirm")
     public HttpResult confirm(@RequestBody @Valid LedgerConfirmReq confirmReq) {
         return HttpResult.ok(kwpLedgerTradeService.confirmOrder(confirmReq));
@@ -183,9 +205,11 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单-驳回查询
      *
-     * @param id
-     * @return
+     * @param id 对账单ID
+     * @return 驳回信息
      */
+    @Operation(summary = "驳回查询", description = "贸易对账单-驳回查询")
+    @Parameter(name = "id", description = "对账单ID", required = true)
     @GetMapping("queryBack")
     public HttpResult queryBack(@NotBlank(message = "id不能为空") @RequestParam("id") String id) {
         return HttpResult.ok(kwpLedgerTradeService.queryBack(Long.valueOf(id)));
@@ -194,9 +218,10 @@ public class AppKwpLedgerTradeController {
     /**
      * 贸易对账单-驳回对账
      *
-     * @param ledgerReq
-     * @return
+     * @param ledgerReq 驳回参数
+     * @return 操作结果
      */
+    @Operation(summary = "驳回对账", description = "贸易对账单-驳回对账")
     @PostMapping("doBack")
     public HttpResult doBack(@RequestBody @Valid LedgerReq ledgerReq) {
         return HttpResult.ok(kwpLedgerTradeService.doBack(ledgerReq));
@@ -208,12 +233,13 @@ public class AppKwpLedgerTradeController {
      * 生成结算单
      * </p>
      *
-     * @param ledgerReq
-     * @return
+     * @param ledgerReq 完成参数
+     * @return 操作结果
      */
+    @Operation(summary = "对账完成", description = "贸易对账单-对账完成，生成结算单")
     @PostMapping("success")
     public HttpResult orderSuccess(@RequestBody @Valid LedgerSuccessReq ledgerReq) {
         return HttpResult.ok(kwpLedgerTradeService.orderSuccess(ledgerReq));
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/app/AppKwpSettlementLogisticsController.java

@@ -4,6 +4,9 @@ import com.sckw.core.web.response.HttpResult;
 import com.sckw.payment.model.constant.LogisticsUnitType;
 import com.sckw.payment.model.vo.req.SettlementReq;
 import com.sckw.payment.service.KwpSettlementLogisticsService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import org.springframework.web.bind.annotation.*;
@@ -14,6 +17,7 @@ import org.springframework.web.bind.annotation.*;
  * @author Aick Spt
  * @date 2023-07-18 16:34
  */
+@Tag(name = "App物流结算管理", description = "提供App端物流订单结算相关操作接口")
 @RestController
 @RequestMapping("/appKwpSettlementLogistics")
 public class AppKwpSettlementLogisticsController {
@@ -22,17 +26,21 @@ public class AppKwpSettlementLogisticsController {
     private KwpSettlementLogisticsService kwpSettlementLogisticsService;
 
     //   ========= 运费收款 承运方 =========
-    @PostMapping(name = "运费收款-物流订单列表", path = "pageListCollection")
+    @Operation(summary = "运费收款-物流订单列表", description = "运费收款-物流订单列表（承运方）")
+    @PostMapping(path = "pageListCollection")
     public HttpResult pageSelectCollection(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.pageSelectCollection(settlementReq));
     }
 
-    @PostMapping(name = "运费收款-物流订单各状态列表总数", path = "getCountListCollection")
+    @Operation(summary = "运费收款-物流订单各状态列表总数", description = "运费收款-物流订单各状态列表总数（承运方）")
+    @PostMapping(path = "getCountListCollection")
     public HttpResult getCountListCollection(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.getCountListCollection(settlementReq));
     }
 
-    @GetMapping(name = "运费收款-物流订单详情", path = "detailCollection")
+    @Operation(summary = "运费收款-物流订单详情", description = "运费收款-物流订单详情（承运方）")
+    @Parameter(name = "id", description = "订单ID", required = true)
+    @GetMapping(path = "detailCollection")
     public HttpResult detailCollection(@RequestParam("id") Long id) {
         return HttpResult.ok(kwpSettlementLogisticsService.detailCollection(id));
     }
@@ -40,9 +48,11 @@ public class AppKwpSettlementLogisticsController {
     /**
      * 承运方 app端
      *
-     * @param id
-     * @return
+     * @param id 订单ID
+     * @return 订单详情
      */
+    @Operation(summary = "承运方订单详情", description = "承运方 app端订单详情")
+    @Parameter(name = "id", description = "订单ID", required = true)
     @GetMapping("carrierDetail")
     public HttpResult carrierDetail(@RequestParam("id") String id) {
         return HttpResult.ok(kwpSettlementLogisticsService.queryDetail(Long.parseLong(id), LogisticsUnitType.SHIPPER));
@@ -50,17 +60,21 @@ public class AppKwpSettlementLogisticsController {
 
 
     //   ========= 运费付款 托运方 =========
-    @PostMapping(name = "运费付款-物流订单列表", path = "pageListPayment")
+    @Operation(summary = "运费付款-物流订单列表", description = "运费付款-物流订单列表（托运方）")
+    @PostMapping(path = "pageListPayment")
     public HttpResult pageSelectPayment(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.pageSelectPayment(settlementReq));
     }
 
-    @PostMapping(name = "运费付款-物流订单各状态列表总数", path = "getCountListPayment")
+    @Operation(summary = "运费付款-物流订单各状态列表总数", description = "运费付款-物流订单各状态列表总数（托运方）")
+    @PostMapping(path = "getCountListPayment")
     public HttpResult getCountListPayment(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(kwpSettlementLogisticsService.getCountListPayment(settlementReq));
     }
 
-    @GetMapping(name = "物流订单详情", path = "detailPayment")
+    @Operation(summary = "物流订单详情", description = "物流订单详情（托运方）")
+    @Parameter(name = "id", description = "订单ID", required = true)
+    @GetMapping(path = "detailPayment")
     public HttpResult detailPayment(@RequestParam("id") Long id) {
         return HttpResult.ok(kwpSettlementLogisticsService.detailPayment(id));
     }
@@ -68,11 +82,13 @@ public class AppKwpSettlementLogisticsController {
     /**
      * app端详情
      *
-     * @param id
-     * @return
+     * @param id 订单ID
+     * @return 订单详情
      */
+    @Operation(summary = "托运方订单详情", description = "托运方 app端订单详情")
+    @Parameter(name = "id", description = "订单ID", required = true)
     @GetMapping("shipperDetail")
     public HttpResult shipperDetail(@RequestParam("id") String id) {
         return HttpResult.ok(kwpSettlementLogisticsService.queryDetail(Long.parseLong(id), LogisticsUnitType.CARRIER));
     }
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/app/AppKwpSettlementTradeController.java

@@ -5,6 +5,9 @@ import com.sckw.core.web.response.HttpResult;
 import com.sckw.payment.model.constant.TradeUnitType;
 import com.sckw.payment.model.vo.req.SettlementTradeReq;
 import com.sckw.payment.service.KwpSettlementTradeService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
@@ -16,6 +19,7 @@ import org.springframework.web.bind.annotation.*;
  *
  * @author xucaiqin
  */
+@Tag(name = "App交易结算管理", description = "提供App端交易订单结算相关操作接口")
 @Validated
 @RestController
 @RequestMapping("/appKwpSettlementTrade")
@@ -29,10 +33,11 @@ public class AppKwpSettlementTradeController {
     /**
      * 销售分页列表
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 结算单列表
      */
-    @PostMapping(name = "收款-销售结算单列表", path = "pageSellList")
+    @Operation(summary = "收款-销售结算单列表", description = "收款-销售结算单列表")
+    @PostMapping(path = "pageSellList")
     public HttpResult pageListCollection(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.setUnitType(TradeUnitType.PURCHASE);
         settlementReq.setUnitTypeTwo(TradeUnitType.SELL);
@@ -43,10 +48,11 @@ public class AppKwpSettlementTradeController {
     /**
      * 待结算、部分结算、全部结算
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 统计结果
      */
-    @PostMapping(name = "收款-表头统计数量", path = "getSellCount")
+    @Operation(summary = "收款-表头统计数量", description = "待结算、部分结算、全部结算统计")
+    @PostMapping(path = "getSellCount")
     public HttpResult getCount(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.setUnitType(TradeUnitType.PURCHASE);
         settlementReq.setUnitTypeTwo(TradeUnitType.SELL);
@@ -57,22 +63,26 @@ public class AppKwpSettlementTradeController {
 
     /**
      * 销售方查询结算单详情
-     * @param id
-     * @return
+     * @param id 结算单ID
+     * @return 结算单详情
      */
-    @GetMapping( "sellDetail")
-    public HttpResult sellDetail(@NotBlank(message = "结算单id不能为空")@RequestParam("id") String id) {
-        return HttpResult.ok(kwpSettlementTradeService.queryDetail(Long.parseLong(id),TradeUnitType.PURCHASE));
+    @Operation(summary = "销售方结算单详情", description = "销售方查询结算单详情")
+    @Parameter(name = "id", description = "结算单ID", required = true)
+    @GetMapping("sellDetail")
+    public HttpResult sellDetail(@NotBlank(message = "结算单id不能为空") @RequestParam("id") String id) {
+        return HttpResult.ok(kwpSettlementTradeService.queryDetail(Long.parseLong(id), TradeUnitType.PURCHASE));
     }
+    
     //   ========= 付款 采购 =========
 
     /**
      * 采购分页列表
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 结算单列表
      */
-    @PostMapping(name = "付款-采购结算单列表", path = "pagePurchaseList")
+    @Operation(summary = "付款-采购结算单列表", description = "付款-采购结算单列表")
+    @PostMapping(path = "pagePurchaseList")
     public HttpResult pageListPayment(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
         settlementReq.setUnitType(TradeUnitType.SELL);
@@ -83,10 +93,11 @@ public class AppKwpSettlementTradeController {
     /**
      * 待结算、部分结算、全部结算
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 统计结果
      */
-    @PostMapping(name = "收款-表头统计数量", path = "getPurchaseCount")
+    @Operation(summary = "付款-表头统计数量", description = "待结算、部分结算、全部结算统计")
+    @PostMapping(path = "getPurchaseCount")
     public HttpResult getPurchaseCount(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
         settlementReq.setUnitType(TradeUnitType.SELL);
@@ -94,14 +105,17 @@ public class AppKwpSettlementTradeController {
         settlementReq.setEntId(LoginUserHolder.getEntId());
         return HttpResult.ok(kwpSettlementTradeService.getCount(settlementReq));
     }
+    
     /**
      * 采购方查询结算单详情
      * @param id 结算单id
-     * @return
+     * @return 结算单详情
      */
-    @GetMapping( "purchaseDetail")
-    public HttpResult purchaseDetail(@NotBlank(message = "结算单id不能为空")@RequestParam("id") String id) {
-        return HttpResult.ok(kwpSettlementTradeService.queryDetail(Long.parseLong(id),TradeUnitType.SELL));
+    @Operation(summary = "采购方结算单详情", description = "采购方查询结算单详情")
+    @Parameter(name = "id", description = "结算单ID", required = true)
+    @GetMapping("purchaseDetail")
+    public HttpResult purchaseDetail(@NotBlank(message = "结算单id不能为空") @RequestParam("id") String id) {
+        return HttpResult.ok(kwpSettlementTradeService.queryDetail(Long.parseLong(id), TradeUnitType.SELL));
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/operate/LedgerLogisticsController.java

@@ -8,6 +8,9 @@ import com.sckw.payment.model.vo.excel.LedgerLogisticsExport;
 import com.sckw.payment.model.vo.req.LedgerListReq;
 import com.sckw.payment.model.vo.req.LogisticsReq;
 import com.sckw.payment.service.operateService.LedgerLogisticsService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -25,6 +28,7 @@ import java.util.stream.Collectors;
  *
  * @author xucaiqin
  */
+@Tag(name = "运营物流对账管理", description = "提供运营端物流对账相关操作接口")
 @Validated
 @RestController
 @RequestMapping("/ledgerLogistics")
@@ -34,9 +38,12 @@ public class LedgerLogisticsController {
 
 
     /**
+     * 查询物流对账单列表
+     *
      * @param logisticsReq 物流订单查询参数
-     * @return
+     * @return 对账单列表
      */
+    @Operation(summary = "物流对账单列表", description = "查询物流对账单列表")
     @PostMapping("list")
     public HttpResult list(@RequestBody LogisticsReq logisticsReq) {
         return HttpResult.ok(ledgerLogisticsService.list(logisticsReq, false));
@@ -46,8 +53,9 @@ public class LedgerLogisticsController {
      * 对账单关联订单
      *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "对账单关联订单", description = "查询对账单关联的订单列表")
     @GetMapping("orderList")
     public HttpResult orderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(ledgerLogisticsService.orderList(ledgerListReq));
@@ -60,15 +68,20 @@ public class LedgerLogisticsController {
      * @param id 物流对账单id
      * @return 物流对账单详情
      */
+    @Operation(summary = "物流对账单详情", description = "根据ID查询物流对账单详情")
+    @Parameter(name = "id", description = "物流对账单ID", required = true)
     @GetMapping("queryDetail")
     public HttpResult queryDetail(@RequestParam("id") @NotBlank(message = "物流对账单id不能为空") String id) {
         return HttpResult.ok(ledgerLogisticsService.queryDetail(Long.valueOf(id)));
     }
 
     /**
+     * 统计物流对账单
+     *
      * @param logisticsReq 物流订单查询参数
      * @return 物流对账单统计数据
      */
+    @Operation(summary = "物流对账单统计", description = "统计物流对账单数据")
     @PostMapping("count")
     public HttpResult count(@RequestBody LogisticsReq logisticsReq) {
         return HttpResult.ok(ledgerLogisticsService.orderCount(logisticsReq));
@@ -76,12 +89,13 @@ public class LedgerLogisticsController {
 
 
     /**
-     * 导出
+     * 导出物流对账单
      *
-     * @param response
-     * @param logisticsReq
-     * @return
+     * @param response     HTTP响应
+     * @param logisticsReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出物流对账单", description = "导出物流对账单数据")
     @PostMapping("export")
     public HttpResult export(HttpServletResponse response, @RequestBody LogisticsReq logisticsReq) {
         List<LedgerLogistics> list;
@@ -103,4 +117,4 @@ public class LedgerLogisticsController {
         ExcelUtil.downData(response, LedgerLogisticsExport.class, collect);
         return null;
     }
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/operate/LedgerTradeController.java

@@ -8,6 +8,9 @@ import com.sckw.payment.model.vo.excel.LedgerTradeExport;
 import com.sckw.payment.model.vo.req.LedgerListReq;
 import com.sckw.payment.model.vo.req.TradeReq;
 import com.sckw.payment.service.operateService.LedgerTradeService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -24,6 +27,7 @@ import java.util.stream.Collectors;
  *
  * @author xucaiqin
  */
+@Tag(name = "运营交易对账管理", description = "提供运营端交易对账相关操作接口")
 @RestController
 @RequestMapping("/ledgerTrade")
 @Validated
@@ -33,18 +37,24 @@ public class LedgerTradeController {
 
 
     /**
-     * @param tradeReq
-     * @return
+     * 查询交易对账单列表
+     *
+     * @param tradeReq 查询参数
+     * @return 对账单列表
      */
+    @Operation(summary = "交易对账单列表", description = "查询交易对账单列表")
     @PostMapping("list")
     public HttpResult list(@RequestBody TradeReq tradeReq) {
         return HttpResult.ok(ledgerTradeService.list(tradeReq));
     }
 
     /**
+     * 对账单关联订单
+     *
      * @param ledgerListReq 对账单id
-     * @return
+     * @return 关联订单列表
      */
+    @Operation(summary = "对账单关联订单", description = "查询对账单关联的订单列表")
     @GetMapping("orderList")
     public HttpResult orderList(@Valid LedgerListReq ledgerListReq) {
         return HttpResult.ok(ledgerTradeService.orderList(ledgerListReq));
@@ -52,9 +62,13 @@ public class LedgerTradeController {
 
 
     /**
+     * 查询交易对账单详情
+     *
      * @param id 对账单id
-     * @return
+     * @return 对账单详情
      */
+    @Operation(summary = "交易对账单详情", description = "根据ID查询交易对账单详情")
+    @Parameter(name = "id", description = "交易对账单ID", required = true)
     @GetMapping("queryDetail")
     public HttpResult queryDetail(@RequestParam("id") String id) {
         return HttpResult.ok(ledgerTradeService.queryDetail(Long.valueOf(id)));
@@ -63,8 +77,10 @@ public class LedgerTradeController {
     /**
      * 贸易订单数分类统计
      *
-     * @return
+     * @param tradeReq 查询参数
+     * @return 统计数据
      */
+    @Operation(summary = "交易对账单统计", description = "贸易订单数分类统计")
     @PostMapping("count")
     public HttpResult count(@RequestBody TradeReq tradeReq) {
         return HttpResult.ok(ledgerTradeService.orderCount(tradeReq));
@@ -72,12 +88,13 @@ public class LedgerTradeController {
 
 
     /**
-     * 导出 todo
+     * 导出交易对账单
      *
-     * @param response
-     * @param tradeReq
-     * @return
+     * @param response HTTP响应
+     * @param tradeReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出交易对账单", description = "导出交易对账单数据")
     @PostMapping("export")
     public HttpResult export(HttpServletResponse response, @RequestBody TradeReq tradeReq) {
         List<LedgerSell> list;
@@ -104,4 +121,4 @@ public class LedgerTradeController {
     }
 
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/operate/OperateWalletController.java

@@ -5,6 +5,8 @@ import com.sckw.payment.model.vo.req.CashPageReq;
 import com.sckw.payment.model.vo.req.WalletDetailReq;
 import com.sckw.payment.model.vo.req.page.PrePayPage;
 import com.sckw.payment.service.WalletService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.validation.annotation.Validated;
@@ -18,6 +20,7 @@ import org.springframework.web.bind.annotation.RestController;
  * @author xucaiqin
  * @date 2023-08-28 15:36:48
  */
+@Tag(name = "运营钱包管理", description = "提供运营端钱包相关操作接口")
 @Validated
 @RestController
 @RequestMapping("/operateWallet")
@@ -30,8 +33,10 @@ public class OperateWalletController {
     /**
      * 查询资金明细
      *
-     * @return
+     * @param walletDetailReq 查询参数
+     * @return 资金明细列表
      */
+    @Operation(summary = "资金明细", description = "查询钱包资金明细")
     @GetMapping("detail")
     public HttpResult detail(WalletDetailReq walletDetailReq) {
         return HttpResult.ok(walletService.walletDetail2(walletDetailReq));
@@ -41,9 +46,10 @@ public class OperateWalletController {
     /**
      * 提现记录
      *
-     * @param cashPageReq
-     * @return
+     * @param cashPageReq 查询参数
+     * @return 提现记录列表
      */
+    @Operation(summary = "提现记录", description = "查询提现记录列表")
     @GetMapping("cashList")
     public HttpResult cashList(CashPageReq cashPageReq) {
         return HttpResult.ok(walletService.cashList2(cashPageReq));
@@ -53,9 +59,10 @@ public class OperateWalletController {
     /**
      * 提现记录 分类统计
      *
-     * @param cashPageReq
-     * @return
+     * @param cashPageReq 查询参数
+     * @return 统计结果
      */
+    @Operation(summary = "提现记录统计", description = "提现记录分类统计")
     @GetMapping("cashCount")
     public HttpResult cashCount(CashPageReq cashPageReq) {
         return HttpResult.ok(walletService.cashCount2(cashPageReq));
@@ -64,12 +71,13 @@ public class OperateWalletController {
     /**
      * 预付列表
      *
-     * @param prePayPage
-     * @return
+     * @param prePayPage 查询参数
+     * @return 预付列表
      */
+    @Operation(summary = "预付列表", description = "查询预付列表")
     @GetMapping("prePayList")
     public HttpResult prePayList(PrePayPage prePayPage) {
         return HttpResult.ok(walletService.prePayList2(prePayPage));
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/operate/SettlementLogisticsController.java

@@ -7,6 +7,8 @@ import com.sckw.payment.model.vo.SettlementLogistics;
 import com.sckw.payment.model.vo.excel.SettlementLogisticsExportVo;
 import com.sckw.payment.model.vo.req.SettlementReq;
 import com.sckw.payment.service.operateService.SettlementLogisticsService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -27,6 +29,7 @@ import java.util.stream.Collectors;
  * @author Aick Spt
  * @date 2023-07-18 16:34
  */
+@Tag(name = "运营物流结算管理", description = "提供运营端物流订单结算相关操作接口")
 @RestController
 @Slf4j
 @RequestMapping("/settlementLogistics")
@@ -37,9 +40,10 @@ public class SettlementLogisticsController {
     /**
      * 结算列表
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 结算列表
      */
+    @Operation(summary = "物流结算列表", description = "查询物流订单结算列表")
     @PostMapping("list")
     public HttpResult list(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(settlementLogisticsService.list(settlementReq));
@@ -48,21 +52,23 @@ public class SettlementLogisticsController {
     /**
      * 结算统计
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 统计结果
      */
+    @Operation(summary = "物流结算统计", description = "统计物流订单结算数据")
     @PostMapping("count")
     public HttpResult count(@RequestBody @Valid SettlementReq settlementReq) {
         return HttpResult.ok(settlementLogisticsService.count(settlementReq));
     }
 
     /**
-     * 导出
+     * 导出结算列表
      *
-     * @param response
-     * @param settlementReq
-     * @return
+     * @param response      HTTP响应
+     * @param settlementReq 查询参数
+     * @return 操作结果
      */
+    @Operation(summary = "导出物流结算列表", description = "导出物流订单结算列表数据")
     @PostMapping("export")
     public HttpResult export(HttpServletResponse response, @RequestBody @Valid SettlementReq settlementReq) {
         settlementReq.setUnitType(LogisticsUnitType.SHIPPER);
@@ -80,4 +86,4 @@ public class SettlementLogisticsController {
         return null;
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/operate/SettlementOfflineController.java

@@ -4,6 +4,8 @@ import com.sckw.core.web.response.HttpResult;
 import com.sckw.payment.model.constant.SettlementOrderTypeEnum;
 import com.sckw.payment.model.vo.req.SettlementOfflineReq;
 import com.sckw.payment.service.operateService.SettlementOfflineService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -16,6 +18,7 @@ import org.springframework.web.bind.annotation.RestController;
  * @author xucaiqin
  * @date 2023-07-20 11:42
  */
+@Tag(name = "运营线下结算管理", description = "提供运营端线下结算记录相关操作接口")
 @RestController
 @RequestMapping("/settlementOffline")
 public class SettlementOfflineController {
@@ -26,9 +29,10 @@ public class SettlementOfflineController {
     /**
      * 贸易-线下付款记录
      *
-     * @param settlementOfflineReq
-     * @return
+     * @param settlementOfflineReq 查询参数
+     * @return 付款记录列表
      */
+    @Operation(summary = "贸易线下付款记录", description = "查询贸易订单线下付款记录")
     @GetMapping("tradeList")
     public HttpResult list(@Valid SettlementOfflineReq settlementOfflineReq) {
         settlementOfflineReq.setOrderType(SettlementOrderTypeEnum.TRADE.getStatus());
@@ -38,13 +42,14 @@ public class SettlementOfflineController {
     /**
      * 物流线下结算记录
      *
-     * @param settlementOfflineReq
-     * @return
+     * @param settlementOfflineReq 查询参数
+     * @return 结算记录列表
      */
+    @Operation(summary = "物流线下结算记录", description = "查询物流订单线下结算记录")
     @GetMapping("logisticsList")
     public HttpResult logisticsList(@Valid SettlementOfflineReq settlementOfflineReq) {
         settlementOfflineReq.setOrderType(SettlementOrderTypeEnum.LOGISTICS.getStatus());
         return HttpResult.ok(settlementOfflineService.list(settlementOfflineReq));
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/operate/SettlementTradeController.java

@@ -7,6 +7,8 @@ import com.sckw.payment.model.vo.SettlementTrade;
 import com.sckw.payment.model.vo.excel.SettlementTradeExportVo;
 import com.sckw.payment.model.vo.req.SettlementTradeReq;
 import com.sckw.payment.service.operateService.SettlementTradeService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -25,8 +27,9 @@ import java.util.stream.Collectors;
  *
  * @author xucaiqin
  */
+@Tag(name = "运营交易结算管理", description = "提供运营端交易订单结算相关操作接口")
 @RestController
-@RequestMapping( "/settlementTrade")
+@RequestMapping("/settlementTrade")
 public class SettlementTradeController {
 
     @Resource
@@ -35,10 +38,11 @@ public class SettlementTradeController {
     /**
      * 销售分页列表
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 结算列表
      */
-    @PostMapping( "list")
+    @Operation(summary = "销售结算列表", description = "查询销售订单结算列表")
+    @PostMapping("list")
     public HttpResult list(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
         return HttpResult.ok(settlementTradeService.list(settlementReq));
@@ -47,10 +51,11 @@ public class SettlementTradeController {
     /**
      * 待结算、部分结算、全部结算
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 统计结果
      */
-    @PostMapping( "count")
+    @Operation(summary = "结算状态统计", description = "按待结算、部分结算、全部结算状态进行统计")
+    @PostMapping("count")
     public HttpResult getCount(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
         return HttpResult.ok(settlementTradeService.getCount(settlementReq));
@@ -59,21 +64,23 @@ public class SettlementTradeController {
     /**
      * 表尾金额结算数据
      *
-     * @param settlementReq
-     * @return
+     * @param settlementReq 查询参数
+     * @return 金额统计
      */
-    @PostMapping( "sum")
+    @Operation(summary = "结算金额统计", description = "统计表尾金额结算数据")
+    @PostMapping("sum")
     public HttpResult sum(@RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
         return HttpResult.ok(settlementTradeService.sumMoney(settlementReq));
     }
 
+    @Operation(summary = "导出结算列表", description = "导出交易结算列表数据")
     @PostMapping("export")
     public HttpResult exportCollection(HttpServletResponse response, @RequestBody @Valid SettlementTradeReq settlementReq) {
         settlementReq.check();
         settlementReq.setUnitType(TradeUnitType.SELL);
         settlementReq.setUnitTypeTwo(TradeUnitType.PURCHASE);
-        List<SettlementTrade> list = settlementTradeService.exportList(settlementReq,settlementReq.getIdList());
+        List<SettlementTrade> list = settlementTradeService.exportList(settlementReq, settlementReq.getIdList());
         if (CollectionUtils.isEmpty(list)) {
             return HttpResult.error("暂无数据，请确认");
         }
@@ -85,4 +92,4 @@ public class SettlementTradeController {
         ExcelUtil.downData(response, SettlementTradeExportVo.class, collect);
         return null;
     }
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/controller/operate/SettlementWalletController.java

@@ -5,6 +5,8 @@ import com.sckw.payment.model.constant.SettlementOrderTypeEnum;
 import com.sckw.payment.model.constant.SettlementWalletPayTypeEnum;
 import com.sckw.payment.model.vo.req.SettlementWalletReq;
 import com.sckw.payment.service.operateService.SettlementWalletService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.annotation.Resource;
 import jakarta.validation.Valid;
 import org.springframework.validation.annotation.Validated;
@@ -16,6 +18,7 @@ import org.springframework.web.bind.annotation.*;
  * @author xucaiqin
  * @date 2023-07-20 14:42
  */
+@Tag(name = "运营电子钱包结算管理", description = "提供运营端电子钱包结算记录相关操作接口")
 @Validated
 @RestController
 @RequestMapping("/settlementWallet")
@@ -26,9 +29,10 @@ public class SettlementWalletController {
     /**
      * 货到付款-物流
      *
-     * @param settlementWalletReq
-     * @return
+     * @param settlementWalletReq 查询参数
+     * @return 结算记录列表
      */
+    @Operation(summary = "货到付款-物流结算记录", description = "查询货到付款类型的物流订单电子钱包结算记录")
     @GetMapping("logisticsList")
     public HttpResult logisticsList(@Valid SettlementWalletReq settlementWalletReq) {
         settlementWalletReq.setPayType(SettlementWalletPayTypeEnum.CASH_ON_DELIVERY.getStatus());
@@ -39,9 +43,10 @@ public class SettlementWalletController {
     /**
      * 货到付款-贸易
      *
-     * @param settlementWalletReq
-     * @return
+     * @param settlementWalletReq 查询参数
+     * @return 结算记录列表
      */
+    @Operation(summary = "货到付款-贸易结算记录", description = "查询货到付款类型的贸易订单电子钱包结算记录")
     @GetMapping("tradeList")
     public HttpResult tradeList(@Valid SettlementWalletReq settlementWalletReq) {
         settlementWalletReq.setPayType(SettlementWalletPayTypeEnum.CASH_ON_DELIVERY.getStatus());
@@ -53,14 +58,15 @@ public class SettlementWalletController {
      * 预付款-贸易
      * 没有预付款-物流这种情况
      *
-     * @param settlementWalletReq
-     * @return
+     * @param settlementWalletReq 查询参数
+     * @return 结算记录列表
      */
-    @GetMapping( "tradePreList")
+    @Operation(summary = "预付款-贸易结算记录", description = "查询预付款类型的贸易订单电子钱包结算记录")
+    @GetMapping("tradePreList")
     public HttpResult tradePreList(@Valid SettlementWalletReq settlementWalletReq) {
         settlementWalletReq.setPayType(SettlementWalletPayTypeEnum.ADVANCE_PAYMENT.getStatus());
         settlementWalletReq.setOrderType(SettlementOrderTypeEnum.TRADE.getStatus());
         return HttpResult.ok(settlementWalletService.pageList(settlementWalletReq));
     }
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/model/JumpUrl.java

@@ -1,5 +1,6 @@
 package com.sckw.payment.model;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -8,17 +9,20 @@ import lombok.Setter;
  * @author xucaiqin
  * @date 2023-09-06 18:58:51
  */
+@Schema(description = "跳转URL实体类")
 @Getter
 @Setter
 public class JumpUrl {
     /**
      * pc端跳转地址
      */
+    @Schema(description = "PC端跳转地址")
     private String pc;
     /**
      * app端跳转地址
      */
+    @Schema(description = "APP端跳转地址")
     private String app;
 
 
-}
+}

sckw-modules/sckw-payment/src/main/java/com/sckw/payment/model/JumpUrlConfig.java

@@ -1,6 +1,7 @@
 package com.sckw.payment.model;
 
 import com.sckw.core.model.constant.Global;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.Setter;
 import org.springframework.boot.context.properties.ConfigurationProperties;
@@ -16,6 +17,7 @@ import java.util.Objects;
  * @author xucaiqin
  * @date 2023-09-06 18:58:51
  */
+@Schema(description = "跳转URL配置类")
 @Getter
 @Setter
 @Component
@@ -25,6 +27,7 @@ public class JumpUrlConfig {
     /**
      * 销售收款对账
      */
+    @Schema(description = "URL映射配置")
     private Map<String, JumpUrl> url = new HashMap<>();
 
     public Map<String, String> getMapUrl(String key) {
@@ -39,4 +42,4 @@ public class JumpUrlConfig {
     }
 
 
-}
+}

sckw-modules/sckw-system/src/main/resources/bootstrap-dev.yml

@@ -3,14 +3,14 @@ spring:
     nacos:
       discovery:
         # 服务注册地址
-        server-addr: 10.10.10.230:8848
+        server-addr: 10.10.10.224:8848
         # 命名空间
         namespace: sckw-ng-service-platform-dev
         # 共享配置
         group: sckw-ng-service-platform
       config:
         # 配置中心地址
-        server-addr: 10.10.10.230:8848
+        server-addr: 10.10.10.224:8848
         # 配置文件格式
         file-extension: yaml
         # 命名空间