From b47ee5029f0260d952ef35d3b8962f101defc901 Mon Sep 17 00:00:00 2001 From: caiyuchao Date: Tue, 17 Dec 2024 15:23:33 +0800 Subject: [PATCH] feat: add interface doc --- .../main/java/org/wfc/user/controller/UCdrController.java | 5 +++++ .../main/java/org/wfc/user/controller/UClientController.java | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UCdrController.java b/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UCdrController.java index bfca929..c956bfa 100644 --- a/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UCdrController.java +++ b/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UCdrController.java @@ -1,5 +1,7 @@ package org.wfc.user.controller; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; @@ -25,6 +27,7 @@ import java.util.List; */ @RestController @RequestMapping("/cdr") +@Tag(name = "用户平台-CDR接口") public class UCdrController extends BaseController { @Autowired @@ -44,6 +47,7 @@ public class UCdrController extends BaseController { * * @return 结果 */ + @Operation(summary = "首页仪表盘") @GetMapping("/getOne") public R getByUser() { UCdrUserVo result = cdrService.getByUser(); @@ -67,6 +71,7 @@ public class UCdrController extends BaseController { * * @return 结果 */ + @Operation(summary = "CDR记录") @GetMapping("/pageHistory") public TableDataInfo getHistoryByUser() { startPage(); diff --git a/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UClientController.java b/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UClientController.java index 2849e01..186b919 100644 --- a/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UClientController.java +++ b/wfc-modules/wfc-modules-user/src/main/java/org/wfc/user/controller/UClientController.java @@ -1,5 +1,7 @@ package org.wfc.user.controller; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; @@ -26,6 +28,7 @@ import java.util.List; */ @RestController @RequestMapping("/client") +@Tag(name = "用户平台-终端设备接口") public class UClientController extends BaseController { @Autowired @@ -45,6 +48,7 @@ public class UClientController extends BaseController { * * @return 结果 */ + @Operation(summary = "当前设备") @GetMapping("/pageCurrentClient") public TableDataInfo getCurrentClients() { startPage(); @@ -57,6 +61,7 @@ public class UClientController extends BaseController { * * @return 结果 */ + @Operation(summary = "历史设备") @GetMapping("/pageHistoryClient") public TableDataInfo getHistoryByUser() { startPage();