From a13f8fdfe445939c0721216095b7fb203f7d610d Mon Sep 17 00:00:00 2001 From: joowojr Date: Thu, 23 Jan 2025 16:11:26 +0900 Subject: [PATCH 1/2] =?UTF-8?q?CLAP-109=20Docs:=20api=20=EB=AA=85=EC=84=B8?= =?UTF-8?q?=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../server/adapter/inbound/web/auth/AuthController.java | 2 +- .../inbound/web/dto/admin/RegisterMemberRequest.java | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/clap/server/adapter/inbound/web/auth/AuthController.java b/src/main/java/clap/server/adapter/inbound/web/auth/AuthController.java index d0694f3c..cc0bb08d 100644 --- a/src/main/java/clap/server/adapter/inbound/web/auth/AuthController.java +++ b/src/main/java/clap/server/adapter/inbound/web/auth/AuthController.java @@ -12,7 +12,7 @@ import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; -@Tag(name = "로그인 / 로그아웃 / 토큰 재발급") +@Tag(name = "로그인 / 로그아웃") @WebAdapter @RequiredArgsConstructor @RequestMapping("/api/auths") diff --git a/src/main/java/clap/server/adapter/inbound/web/dto/admin/RegisterMemberRequest.java b/src/main/java/clap/server/adapter/inbound/web/dto/admin/RegisterMemberRequest.java index 26978089..1fe5b31b 100644 --- a/src/main/java/clap/server/adapter/inbound/web/dto/admin/RegisterMemberRequest.java +++ b/src/main/java/clap/server/adapter/inbound/web/dto/admin/RegisterMemberRequest.java @@ -7,14 +7,14 @@ import jakarta.validation.constraints.Pattern; public record RegisterMemberRequest( - @NotBlank @Schema(description = "회원 이름") + @NotBlank @Schema(description = "회원 이름", example = "서주원") String name, @NotBlank @Pattern(regexp = "^[a-zA-Z0-9_+&*-]+(?:\\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,7}$", message = "올바른 이메일 형식이 아닙니다.") - @Schema(description = "회원 이메일") + @Schema(description = "회원 이메일", example = "siena@gmail.com") String email, - @NotBlank @Schema(description = "회원 닉네임, 로그인할 때 쓰입니다.") + @NotBlank @Schema(description = "회원 닉네임, 로그인할 때 쓰입니다.", example = "siena.it") @Pattern(regexp = "^[a-z]{3,10}\\.[a-z]{1,5}$", message = "올바른 닉네임 형식이 아닙니다.") String nickname, From 56ee2f5f593af17e88f2108fae0ff71d5856a8fa Mon Sep 17 00:00:00 2001 From: joowojr Date: Thu, 23 Jan 2025 16:14:27 +0900 Subject: [PATCH 2/2] =?UTF-8?q?CLAP-109=20Docs:=20url=20path=20=ED=86=B5?= =?UTF-8?q?=EC=9D=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../web/statistics/FindStatisticsController.java | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/main/java/clap/server/adapter/inbound/web/statistics/FindStatisticsController.java b/src/main/java/clap/server/adapter/inbound/web/statistics/FindStatisticsController.java index 12b02bff..ecdfda02 100644 --- a/src/main/java/clap/server/adapter/inbound/web/statistics/FindStatisticsController.java +++ b/src/main/java/clap/server/adapter/inbound/web/statistics/FindStatisticsController.java @@ -5,15 +5,19 @@ import clap.server.application.port.inbound.statistics.FindPeriodTaskRequestUsecase; import clap.server.application.port.inbound.statistics.FindSubCategoryTaskRequestUsecase; import clap.server.common.annotation.architecture.WebAdapter; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import java.util.Map; +@Tag(name = "작업 관련 통계") @WebAdapter @RequiredArgsConstructor +@RequestMapping("/api/tasks/statistics") public class FindStatisticsController { private final FindPeriodTaskRequestUsecase findPeriodTaskRequestUsecase; private final FindPeriodTaskProcessUsecase findPeriodTaskProcessUsecase; @@ -21,21 +25,21 @@ public class FindStatisticsController { private final FindSubCategoryTaskRequestUsecase findSubCategoryTaskRequestUsecase; // private final ManagerTaskProcessUsecase managerTaskProcessUsecase; - @GetMapping(value = "/task/statistics/task-requests-by-period") + @GetMapping(value = "/task-requests-by-period") public ResponseEntity> aggregatePeriodTaskRequest(@RequestParam String period) { return ResponseEntity.ok(findPeriodTaskRequestUsecase.aggregatePeriodTaskRequest(period)); } - @GetMapping("/task/statistics/task-processed-by-period") + @GetMapping("/task-processed-by-period") public ResponseEntity> aggregatePeriodTaskProcess(@RequestParam String period) { return ResponseEntity.ok(findPeriodTaskProcessUsecase.aggregatePeriodTaskProcess(period)); } - @GetMapping("/task/statistics/task-requests-by-category") + @GetMapping("/task-requests-by-category") public ResponseEntity> aggregateCategoryTaskRequest(@RequestParam String period) { return ResponseEntity.ok(findCategoryTaskRequestUsecase.aggregateCategoryTaskRequest(period)); } - @GetMapping("/task/statistics/task-requests-by-subcategory") + @GetMapping("/task-requests-by-subcategory") public ResponseEntity> aggregateSubCategoryTaskRequest(@RequestParam String period, @RequestParam String mainCategory) { return ResponseEntity.ok(findSubCategoryTaskRequestUsecase.aggregateSubCategoryTaskRequest(period, mainCategory)); }