Merge pull request #139 from TaskFlow-CLAP/CLAP-158

CLAP-158 Swagger 컨트롤러단 명세 작성

Author: joowojr

src/main/java/clap/server/adapter/inbound/web/admin/AddCategoryController.java

@@ -15,7 +15,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 
-@Tag(name = "카테고리 추가")
+@Tag(name = "05. Admin")
 @WebAdapter
 @RequiredArgsConstructor
 @RequestMapping("/api/managements")

src/main/java/clap/server/adapter/inbound/web/admin/ManageMemberController.java

@@ -15,14 +15,14 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 
-@Tag(name = "회원 관리 - 수정/ 삭제")
+@Tag(name = "05. Admin")
 @WebAdapter
 @RequiredArgsConstructor
 @RequestMapping("/api/managements/members")
 public class ManageMemberController {
     private final ManageMemberUsecase manageMemberUsecase;
 
-    @Operation(summary = "단일 회원 등록 API")
+    @Operation(summary = "회원 정보 수정 API")
     @PostMapping("/{memberId}")
     @Secured("ROLE_ADMIN")
     public void registerMember(@AuthenticationPrincipal SecurityUserDetails userInfo,

src/main/java/clap/server/adapter/inbound/web/admin/RegisterMemberController.java

@@ -14,7 +14,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 
-@Tag(name = "회원 관리 - 등록")
+@Tag(name = "05. Admin")
 @WebAdapter
 @RequiredArgsConstructor
 @RequestMapping("/api/managements")

src/main/java/clap/server/adapter/inbound/web/auth/AuthController.java

@@ -18,7 +18,7 @@
 import static clap.server.common.utils.ClientIpParseUtil.getClientIp;
 
 @Slf4j
-@Tag(name = "로그인 / 로그아웃")
+@Tag(name = "00. Auth", description = "로그인, 로그아웃, 토큰 재발급 API")
 @WebAdapter
 @RequiredArgsConstructor
 @RequestMapping("/api/auths")

src/main/java/clap/server/adapter/inbound/web/auth/ReissueTokenController.java

@@ -11,7 +11,7 @@
 import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestMapping;
 
-@Tag(name = "토큰 재발급")
+@Tag(name = "00. Auth")
 @WebAdapter
 @RequiredArgsConstructor
 @RequestMapping("/api/auths")

src/main/java/clap/server/adapter/inbound/web/dto/statistics/StatisticsResponse.java

@@ -1,5 +1,7 @@
 package clap.server.adapter.inbound.web.dto.statistics;
 
-public record StatisticsResponse(String key, long count) {
+public record StatisticsResponse(
+        String key,
+        long count) {
 
 }

src/main/java/clap/server/adapter/inbound/web/member/MemberInfoController.java

@@ -12,7 +12,7 @@
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 
-@Tag(name = "회원 정보 조회/수정")
+@Tag(name = "01. Member", description = "회원 정보 조회 및 수정 API")
 @WebAdapter
 @RequiredArgsConstructor
 @RequestMapping("/api/members")

src/main/java/clap/server/adapter/inbound/web/member/ResetPasswordController.java

@@ -13,7 +13,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 
-@Tag(name = "비밀번호 재설정")
+@Tag(name = "01. Member")
 @WebAdapter
 @RequiredArgsConstructor
 @RequestMapping("/api")

src/main/java/clap/server/adapter/inbound/web/notification/FindNotificationController.java

@@ -19,7 +19,7 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
-@Tag(name = "알림 관리 - 조회")
+@Tag(name = "04. Notification")
 @WebAdapter
 @RestController
 @RequestMapping("/api/notifications")

src/main/java/clap/server/adapter/inbound/web/notification/ManagementNotificationController.java

@@ -14,7 +14,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-@Tag(name = "알림 읽음 처리")
+@Tag(name = "04. Notification")
 @WebAdapter
 @RestController
 @RequestMapping("/api/notification")