Merge pull request #285 from prgrms-web-devcourse-final-project/refactor/EA3-206-refactor-responseentity

pia01190 · web-flow · commit 13ce148ffa18 · 2025-07-29T15:56:44.000+09:00
[EA3-206] Refactor: 응답값에 대한 변경
diff --git a/src/main/java/grep/neogulcoder/domain/admin/controller/AdminController.java b/src/main/java/grep/neogulcoder/domain/admin/controller/AdminController.java
@@ -10,6 +10,7 @@
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
+import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -27,46 +28,46 @@ public class AdminController implements AdminSpecification {
     private final AdminService adminService;
 
     @GetMapping("/users")
-    public ApiResponse<Page<AdminUserResponse>> getUsers(
+    public ResponseEntity<ApiResponse<Page<AdminUserResponse>>> getUsers(
         @RequestParam(defaultValue = "0") int page,
         @RequestParam(required = false) String email) {
         int size = 10;
         Pageable pageable = PageRequest.of(page, size);
-        return ApiResponse.success(adminService.getAllUsers(pageable, email));
+        return ResponseEntity.ok(ApiResponse.success(adminService.getAllUsers(pageable, email)));
     }
 
     @GetMapping("/studies")
-    public ApiResponse<Page<AdminStudyResponse>> getStudies(
+    public ResponseEntity<ApiResponse<Page<AdminStudyResponse>>> getStudies(
         @RequestParam(defaultValue = "0") int page,
         @RequestParam(required = false) String name,
         @RequestParam(required = false) Category category) {
-        return ApiResponse.success(adminService.getAllStudies(page,name,category));
+        return ResponseEntity.ok(ApiResponse.success(adminService.getAllStudies(page,name,category)));
     }
 
     @GetMapping("/recruitment-posts")
-    public ApiResponse<Page<AdminRecruitmentPostResponse>> getRecruitmentPosts(
+    public ResponseEntity<ApiResponse<Page<AdminRecruitmentPostResponse>>> getRecruitmentPosts(
         @RequestParam(defaultValue = "0") int page,
         @RequestParam(required = false) String subject) {
 
-        return ApiResponse.success(adminService.getAllRecruitmentPosts(page, subject));
+        return ResponseEntity.ok(ApiResponse.success(adminService.getAllRecruitmentPosts(page, subject)));
     }
 
     @DeleteMapping("/users/{userId}")
-    public ApiResponse<Void> deleteUser(@PathVariable Long userId) {
+    public ResponseEntity<ApiResponse<Void>> deleteUser(@PathVariable Long userId) {
         adminService.deleteUser(userId);
-        return ApiResponse.noContent();
+        return ResponseEntity.ok(ApiResponse.noContent());
     }
 
     @DeleteMapping("/studies/{studyId}")
-    public ApiResponse<Void> deleteStudy(@PathVariable Long studyId) {
+    public ResponseEntity<ApiResponse<Void>> deleteStudy(@PathVariable Long studyId) {
         adminService.deleteStudy(studyId);
-        return ApiResponse.noContent();
+        return ResponseEntity.ok(ApiResponse.noContent());
     }
 
     @DeleteMapping("/recruitment-posts/{postId}")
-    public ApiResponse<Void> deleteRecruitmentPost(@PathVariable Long postId) {
+    public ResponseEntity<ApiResponse<Void>> deleteRecruitmentPost(@PathVariable Long postId) {
         adminService.deleteRecruitmentPost(postId);
-        return ApiResponse.noContent();
+        return ResponseEntity.ok(ApiResponse.noContent());
     }
 
 }
diff --git a/src/main/java/grep/neogulcoder/domain/admin/controller/AdminSpecification.java b/src/main/java/grep/neogulcoder/domain/admin/controller/AdminSpecification.java
@@ -9,6 +9,7 @@
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.data.domain.Page;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -19,14 +20,14 @@ public interface AdminSpecification {
 
     @Operation(summary = "전체 사용자 조회", description = "관리자가 전체 유저 목록을 페이지 단위로 조회합니다.")
     @GetMapping("/admin/users")
-    ApiResponse<Page<AdminUserResponse>> getUsers(
+    ResponseEntity<ApiResponse<Page<AdminUserResponse>>> getUsers(
         @Parameter(description = "페이지 번호 (0부터 시작)", example = "0")
         @RequestParam(defaultValue = "0") int page, @RequestParam(required = false) String email
     );
 
     @Operation(summary = "전체 스터디 조회", description = "관리자가 전체 스터디 목록을 페이지 단위로 조회합니다.")
     @GetMapping("/admin/studies")
-    ApiResponse<Page<AdminStudyResponse>> getStudies(
+    ResponseEntity<ApiResponse<Page<AdminStudyResponse>>> getStudies(
         @Parameter(description = "페이지 번호 (0부터 시작)", example = "0")
         @RequestParam(defaultValue = "0") int page,
         @RequestParam(required = false) String name,
@@ -35,29 +36,29 @@ ApiResponse<Page<AdminStudyResponse>> getStudies(
 
     @Operation(summary = "전체 모집글 조회", description = "관리자가 전체 모집글 목록을 페이지 단위로 조회합니다.")
     @GetMapping("/admin/recruitment-posts")
-    ApiResponse<Page<AdminRecruitmentPostResponse>> getRecruitmentPosts(
+    ResponseEntity<ApiResponse<Page<AdminRecruitmentPostResponse>>> getRecruitmentPosts(
         @Parameter(description = "페이지 번호 (0부터 시작)", example = "0")
         @RequestParam(defaultValue = "0") int page,
         @RequestParam(required = false) String subject
     );
 
     @Operation(summary = "사용자 강제 탈퇴", description = "관리자가 특정 사용자를 탈퇴(삭제) 처리합니다.")
     @DeleteMapping("/admin/users/{userId}")
-    ApiResponse<Void> deleteUser(
+    ResponseEntity<ApiResponse<Void>> deleteUser(
         @Parameter(description = "삭제할 사용자 ID", example = "1")
         @PathVariable Long userId
     );
 
     @Operation(summary = "스터디 비활성화", description = "관리자가 특정 스터디를 비활성화(삭제) 처리합니다.")
     @DeleteMapping("/admin/studies/{studyId}")
-    ApiResponse<Void> deleteStudy(
+    ResponseEntity<ApiResponse<Void>> deleteStudy(
         @Parameter(description = "삭제할 스터디 ID", example = "1")
         @PathVariable Long studyId
     );
 
     @Operation(summary = "모집글 삭제", description = "관리자가 특정 모집글을 삭제 처리합니다.")
     @DeleteMapping("/admin/recruitment-posts/{postId}")
-    ApiResponse<Void> deleteRecruitmentPost(
+    ResponseEntity<ApiResponse<Void>> deleteRecruitmentPost(
         @Parameter(description = "삭제할 모집글 ID", example = "1")
         @PathVariable Long postId
     );
diff --git a/src/main/java/grep/neogulcoder/domain/alram/controller/AlarmController.java b/src/main/java/grep/neogulcoder/domain/alram/controller/AlarmController.java
@@ -4,11 +4,15 @@
 import grep.neogulcoder.domain.alram.service.AlarmService;
 import grep.neogulcoder.global.auth.Principal;
 import grep.neogulcoder.global.response.ApiResponse;
+import java.util.List;
 import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
-import org.springframework.web.bind.annotation.*;
-
-import java.util.List;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
 
 @RestController
 @RequiredArgsConstructor
@@ -18,33 +22,39 @@ public class AlarmController implements AlarmSpecification {
     private final AlarmService alarmService;
 
     @GetMapping("/my")
-    public ApiResponse<List<AlarmResponse>> getAllAlarms(@AuthenticationPrincipal Principal userDetails) {
-        return ApiResponse.success(alarmService.getAllAlarms(userDetails.getUserId()));
+    public ResponseEntity<ApiResponse<List<AlarmResponse>>> getAllAlarms(
+        @AuthenticationPrincipal Principal userDetails) {
+        return ResponseEntity.ok(
+            ApiResponse.success(alarmService.getAllAlarms(userDetails.getUserId())));
     }
 
     @GetMapping("/unchecked/my")
-    public ApiResponse<List<AlarmResponse>> getAllUncheckedAlarm(
-            @AuthenticationPrincipal Principal userDetails) {
-        return ApiResponse.success(alarmService.getAllUncheckedAlarms(userDetails.getUserId()));
+    public ResponseEntity<ApiResponse<List<AlarmResponse>>> getAllUncheckedAlarm(
+        @AuthenticationPrincipal Principal userDetails) {
+        return ResponseEntity.ok(
+            ApiResponse.success(alarmService.getAllUncheckedAlarms(userDetails.getUserId())));
     }
 
     @PostMapping("/my/check/all")
-    public ApiResponse<Void> checkAlarm(@AuthenticationPrincipal Principal userDetails) {
+    public ResponseEntity<ApiResponse<Void>> checkAlarm(
+        @AuthenticationPrincipal Principal userDetails) {
         alarmService.checkAllAlarmWithoutInvite(userDetails.getUserId());
-        return ApiResponse.noContent();
+        return ResponseEntity.ok(ApiResponse.noContent());
     }
 
     @PostMapping("/choose/{alarmId}/response")
-    public ApiResponse<Void> respondToInvite(@AuthenticationPrincipal Principal principal,
-                                             @PathVariable Long alarmId,
-                                             boolean accepted) {
+    public ResponseEntity<ApiResponse<Void>> respondToInvite(
+        @AuthenticationPrincipal Principal principal,
+        @PathVariable Long alarmId,
+        boolean accepted) {
         if (accepted) {
             alarmService.acceptInvite(principal.getUserId(), alarmId);
         } else {
             alarmService.rejectInvite(principal.getUserId(), alarmId);
         }
 
-        return ApiResponse.success(accepted ? "스터디 초대를 수락했습니다." : "스터디 초대를 거절했습니다.");
+        return ResponseEntity.ok(
+            ApiResponse.success(accepted ? "스터디 초대를 수락했습니다." : "스터디 초대를 거절했습니다."));
     }
 
 }
diff --git a/src/main/java/grep/neogulcoder/domain/alram/controller/AlarmSpecification.java b/src/main/java/grep/neogulcoder/domain/alram/controller/AlarmSpecification.java
@@ -6,17 +6,26 @@
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
+import org.springframework.http.ResponseEntity;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.PathVariable;
 
 @Tag(name = "Alarm", description = "알림 관련 API 명세")
 public interface AlarmSpecification {
 
     @Operation(summary = "읽음 여부 관련 없이 내 전체 알림 목록 조회", description = "로그인한 사용자의 전체 알림 목록을 조회합니다.")
-    ApiResponse<List<AlarmResponse>> getAllAlarms(@AuthenticationPrincipal Principal userDetails);
+    ResponseEntity<ApiResponse<List<AlarmResponse>>> getAllAlarms(
+        @AuthenticationPrincipal Principal userDetails);
 
     @Operation(summary = "내 읽지 않은 알림 목록 조회", description = "로그인한 사용자의 읽지 않은 알림 목록을 조회합니다.")
-    ApiResponse<List<AlarmResponse>> getAllUncheckedAlarm(@AuthenticationPrincipal Principal userDetails);
+    ResponseEntity<ApiResponse<List<AlarmResponse>>> getAllUncheckedAlarm(
+        @AuthenticationPrincipal Principal userDetails);
 
     @Operation(summary = "내 알림 전체 읽음 처리", description = "로그인한 사용자의 모든 알림을 읽음 처리합니다.")
-    ApiResponse<Void> checkAlarm(@AuthenticationPrincipal Principal userDetails);
+    ResponseEntity<ApiResponse<Void>> checkAlarm(@AuthenticationPrincipal Principal userDetails);
+
+    @Operation(summary = "스터디 수락/거절", description = "스터디 초대를 수락/거절합니다.")
+    ResponseEntity<ApiResponse<Void>> respondToInvite(@AuthenticationPrincipal Principal principal,
+        @PathVariable Long alarmId,
+        boolean accepted);
 }
diff --git a/src/main/java/grep/neogulcoder/domain/prtemplate/controller/PrTemplateController.java b/src/main/java/grep/neogulcoder/domain/prtemplate/controller/PrTemplateController.java
@@ -8,6 +8,7 @@
 import grep.neogulcoder.global.auth.Principal;
 import grep.neogulcoder.global.response.ApiResponse;
 import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -25,29 +26,29 @@ public class PrTemplateController implements PrTemplateSpecification {
     private final LinkService linkService;
 
     @GetMapping("/mine")
-    public ApiResponse<PrPageResponse> get(@AuthenticationPrincipal Principal principal) {
+    public ResponseEntity<ApiResponse<PrPageResponse>> get(@AuthenticationPrincipal Principal principal) {
         PrPageResponse prPageResponse = prTemplateService.toResponse(principal.getUserId());
-        return ApiResponse.success(prPageResponse);
+        return ResponseEntity.ok(ApiResponse.success(prPageResponse));
     }
 
     @GetMapping("/{userid}")
-    public ApiResponse<PrPageResponse> get(@PathVariable("userid") Long userId) {
+    public ResponseEntity<ApiResponse<PrPageResponse>> get(@PathVariable("userid") Long userId) {
         PrPageResponse prPageResponse = prTemplateService.toResponse(userId);
-        return ApiResponse.success(prPageResponse);
+        return ResponseEntity.ok(ApiResponse.success(prPageResponse));
     }
 
     @PutMapping("/update/template")
-    public ApiResponse<Void> update(@AuthenticationPrincipal Principal principal,
+    public ResponseEntity<ApiResponse<Void>> update(@AuthenticationPrincipal Principal principal,
         @RequestBody PrUpdateRequest request) {
         prTemplateService.update(principal.getUserId(), request.getLocation());
         linkService.update(principal.getUserId(), request.getPrUrls());
-        return ApiResponse.noContent();
+        return ResponseEntity.ok(ApiResponse.noContent());
     }
 
     @PutMapping("/update/introduction")
-    public ApiResponse<Void> updateIntroduction(@AuthenticationPrincipal Principal principal,
+    public ResponseEntity<ApiResponse<Void>> updateIntroduction(@AuthenticationPrincipal Principal principal,
         @RequestBody IntroductionUpdateRequest request) {
         prTemplateService.updateIntroduction(principal.getUserId(), request.getIntroduction());
-        return ApiResponse.noContent();
+        return ResponseEntity.ok(ApiResponse.noContent());
     }
 }
diff --git a/src/main/java/grep/neogulcoder/domain/prtemplate/controller/PrTemplateSpecification.java b/src/main/java/grep/neogulcoder/domain/prtemplate/controller/PrTemplateSpecification.java
@@ -7,19 +7,24 @@
 import grep.neogulcoder.global.response.ApiResponse;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.http.ResponseEntity;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
 
 @Tag(name = "PR_Template", description = "PR 템플릿 API")
 public interface PrTemplateSpecification {
 
     @Operation(summary = "PR 템플릿 조회", description = "PR 템플릿을 조회합니다.")
-    ApiResponse<PrPageResponse> get(@AuthenticationPrincipal Principal principal);
+    ResponseEntity<ApiResponse<PrPageResponse>> get(@AuthenticationPrincipal Principal principal);
+
+    @Operation(summary = "타인 PR 템플릿 조회", description = "회원 ID를 통해 PR 템플릿을 조회합니다.")
+    ResponseEntity<ApiResponse<PrPageResponse>> get(@PathVariable("userid") Long userId);
 
     @Operation(summary = "PR 정보 수정", description = "PR 정보를 수정합니다.")
-    ApiResponse<Void> update(@AuthenticationPrincipal Principal principal, @RequestBody PrUpdateRequest request);
+    ResponseEntity<ApiResponse<Void>> update(@AuthenticationPrincipal Principal principal, @RequestBody PrUpdateRequest request);
 
     @Operation(summary = "PR 소개글 수정", description = "PR 소개글을 수정합니다.")
-    ApiResponse<Void> updateIntroduction(@AuthenticationPrincipal Principal principal, @RequestBody IntroductionUpdateRequest request);
+    ResponseEntity<ApiResponse<Void>> updateIntroduction(@AuthenticationPrincipal Principal principal, @RequestBody IntroductionUpdateRequest request);
 
 }
diff --git a/src/main/java/grep/neogulcoder/domain/users/controller/UserController.java b/src/main/java/grep/neogulcoder/domain/users/controller/UserController.java
diff --git a/src/main/java/grep/neogulcoder/domain/users/controller/UserSpecification.java b/src/main/java/grep/neogulcoder/domain/users/controller/UserSpecification.java
