Merge pull request #257 from CodIN-INU/fix/256-fcm-subscribe

fix: fcm 토큰 저장 로직 수정

Author: doma17

…/infra/fcm/controller/FcmController.java …ra/fcm/controller/FcmControllerImpl.javasrc/main/java/inu/codin/codin/infra/fcm/controller/FcmController.java renamed to src/main/java/inu/codin/codin/infra/fcm/controller/FcmControllerImpl.java src/main/java/inu/codin/codin/infra/fcm/controller/FcmController.java renamed to src/main/java/inu/codin/codin/infra/fcm/controller/FcmControllerImpl.java

@@ -1,45 +1,42 @@
 package inu.codin.codin.infra.fcm.controller;
 
 import inu.codin.codin.common.response.SingleResponse;
+import inu.codin.codin.infra.fcm.controller.swagger.FcmController;
 import inu.codin.codin.infra.fcm.dto.request.FcmTokenRequest;
 import inu.codin.codin.infra.fcm.service.FcmService;
-import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
+import jakarta.validation.constraints.Null;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
 
 @RestController
 @RequestMapping("/fcm")
-@Tag(name = "FCM API", description = "FCM 토큰 저장 API")
 @RequiredArgsConstructor
-public class FcmController {
+public class FcmControllerImpl implements FcmController {
 
     private final FcmService fcmService;
 
     @PostMapping("/save")
-    public ResponseEntity<?> sendFcmMessage(
+    public ResponseEntity<SingleResponse<Null>> sendFcmMessage(
             @RequestBody @Valid FcmTokenRequest fcmTokenRequest
     ) {
         fcmService.saveFcmToken(fcmTokenRequest);
         return ResponseEntity.status(HttpStatus.ACCEPTED).body(new SingleResponse<>(202, "FCM 토큰 저장 성공", null));
     }
 
     @PostMapping("/subscribe")
-    public ResponseEntity<?> subscribeTopic(
-            @RequestBody String topic
+    public ResponseEntity<SingleResponse<Null>> subscribeTopic(
+            @RequestParam String topic
     ) {
         fcmService.subscribeTopic(topic);
         return ResponseEntity.status(HttpStatus.ACCEPTED).body(new SingleResponse<>(202, "FCM 토픽 구독 성공", null));
     }
 
     @PostMapping("/unsubscribe")
-    public ResponseEntity<?> unsubscribeTopic(
-            @RequestBody String topic
+    public ResponseEntity<SingleResponse<Null>> unsubscribeTopic(
+            @RequestParam String topic
     ) {
         fcmService.unsubscribeTopic(topic);
         return ResponseEntity.status(HttpStatus.ACCEPTED).body(new SingleResponse<>(202, "FCM 토픽 구독 해제 성공", null));

src/main/java/inu/codin/codin/infra/fcm/controller/swagger/FcmController.java

@@ -0,0 +1,30 @@
+package inu.codin.codin.infra.fcm.controller.swagger;
+
+import inu.codin.codin.common.response.SingleResponse;
+import inu.codin.codin.infra.fcm.dto.request.FcmTokenRequest;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Null;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
+
+@Tag(name = "FCM API", description = "FCM 토큰 저장 API")
+public interface FcmController {
+
+    @Operation(summary = "FCM 토큰 저장", description = "알림 설정을 위해서는 미리 토큰 저장이 필요합니다")
+    public ResponseEntity<SingleResponse<Null>> sendFcmMessage(
+            @RequestBody @Valid FcmTokenRequest fcmTokenRequest
+    );
+
+    @Operation(summary = "FCM 토픽 구독", description = "토픽을 구독하여 해당 토픽으로 알림이 옵니다.")
+    public ResponseEntity<SingleResponse<Null>> subscribeTopic(
+            @RequestParam String topic
+    );
+
+    @Operation(summary = "FCM 토픽 구독 해제", description = "토픽 구독을 해제합니다.")
+    public ResponseEntity<SingleResponse<Null>> unsubscribeTopic(
+            @RequestParam String topic
+    );
+}

src/main/java/inu/codin/codin/infra/fcm/dto/request/FcmTokenRequest.java

@@ -9,11 +9,11 @@
 @Getter
 public class FcmTokenRequest {
 
-    @Schema(description = "Fcm Token")
+    @Schema(description = "Fcm Token", example = "FCM 토큰")
     @NotBlank
     private String fcmToken;
 
-    @Schema(description = "Android, IOS")
+    @Schema(description = "Android, IOS", example = "디바이스 종류")
     @NotBlank
     private String deviceType;