[DOCS] 알림 관련 api 명세 추가 및 인증로직 도입 (#126)

* [DOCS] 알림 관련 swagger 명세 작성

* [FEAT] 인증 처리 추가

* [REFACTOR] 사용하지 않는 import 제거

* [REFACTOR] 필요하지 않은 SecurityRequirement 삭제

* [REFACTOR] 필요하지 않은 SecurityRequirement 삭제

Author: qmean

src/main/java/com/brainpix/alarm/controller/AlarmController.java

@@ -7,92 +7,101 @@
 import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RequestPart;
 import org.springframework.web.bind.annotation.RestController;
 
 import com.brainpix.alarm.dto.GetAlarmDto;
 import com.brainpix.alarm.dto.GetUnreadAlarmDto;
 import com.brainpix.alarm.service.AlarmService;
 import com.brainpix.api.ApiResponse;
+import com.brainpix.security.authorization.AllUser;
+import com.brainpix.security.authorization.UserId;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/alarm")
+@Tag(name = "Alarm", description = "알림 관련 API")
 public class AlarmController {
 
 	private final AlarmService alarmService;
 
-	// 알림 읽음 처리 API
+	@AllUser
 	@PatchMapping("/read/{alarmId}")
-	public ResponseEntity<ApiResponse<Void>> readAlarm(@PathVariable String alarmId, @RequestParam Long userId) {
+	@Operation(summary = "알림 읽음 처리 API", description = "알림을 읽음 처리합니다.")
+	public ResponseEntity<ApiResponse<Void>> readAlarm(@PathVariable String alarmId, @UserId Long userId) {
 
 		alarmService.readAlarm(alarmId, userId);
 
 		return ResponseEntity.ok(ApiResponse.successWithNoData());
 	}
 
-	// 일반 알림 조회 API
-	// 시큐리티 적용 전까지 임시로 userId를 RequestParam 으로 받아서 사용
+	@AllUser
 	@GetMapping
-	public ResponseEntity<ApiResponse<GetAlarmDto.Response>> getAlarmList(Pageable pageable, @RequestParam Long userId) {
+	@Operation(summary = "알림 다건 조회 API", description = "여러건의 알림을 조회합니다.")
+	public ResponseEntity<ApiResponse<GetAlarmDto.Response>> getAlarmList(Pageable pageable, @UserId Long userId) {
 
 		GetAlarmDto.Response data = alarmService.getAlarm(pageable, userId);
 
 		return ResponseEntity.ok(ApiResponse.success(data));
 	}
 
-	// 휴지통 알림 조회 API
-	// 시큐리티 적용 전까지 임시로 userId를 RequestParam 으로 받아서 사용
+	@AllUser
 	@GetMapping("/trash")
-	public ResponseEntity<ApiResponse<GetAlarmDto.Response>> getTrashAlarmList(Pageable pageable, @RequestPart Long userId) {
+	@Operation(summary = "휴지통 알림 조회 API", description = "휴지통에 있는 알림들을 조회합니다.")
+	public ResponseEntity<ApiResponse<GetAlarmDto.Response>> getTrashAlarmList(Pageable pageable, @UserId Long userId) {
 
 		GetAlarmDto.Response data = alarmService.getTrashAlarm(pageable, userId);
 
 		return ResponseEntity.ok(ApiResponse.success(data));
 	}
 
-	// 알림 수 조회 API
+	@AllUser
 	@GetMapping("/count")
-	public ResponseEntity<ApiResponse<GetUnreadAlarmDto.Response>> getUnreadAlarmCount(@RequestParam Long userId) {
+	@Operation(summary = "알림 개수 조회 API", description = "알림 개수를 조회합니다.")
+	public ResponseEntity<ApiResponse<GetUnreadAlarmDto.Response>> getUnreadAlarmCount(@UserId Long userId) {
 
 		GetUnreadAlarmDto.Response data = alarmService.getUnreadAlarmCount(userId);
 
 		return ResponseEntity.ok(ApiResponse.success(data));
 	}
 
-	// 알림 휴지통으로 보내기 API
+	@AllUser
 	@PatchMapping("/trash/{alarmId}")
-	public ResponseEntity<ApiResponse<Void>> addTrashAlarm(@PathVariable String alarmId, @RequestParam Long userId) {
+	@Operation(summary = "알림 휴지통으로 보내기 API", description = "알림 하나를 휴지통으로 보냅니다.")
+	public ResponseEntity<ApiResponse<Void>> addTrashAlarm(@PathVariable String alarmId, @UserId Long userId) {
 
 		alarmService.addTrashAlarm(alarmId, userId);
 
 		return ResponseEntity.ok(ApiResponse.successWithNoData());
 	}
 
-	// 알림 휴지통에서 복구 API
+	@AllUser
 	@PatchMapping("/restore/{alarmId}")
-	public ResponseEntity<ApiResponse<Void>> restoreAlarm(@PathVariable String alarmId, @RequestParam Long userId) {
+	@Operation(summary = "휴지통에서 알림 복구 API", description = "휴지통에서 알림을 복구합니다.")
+	public ResponseEntity<ApiResponse<Void>> restoreAlarm(@PathVariable String alarmId, @UserId Long userId) {
 
 		alarmService.restoreAlarm(alarmId, userId);
 
 		return ResponseEntity.ok(ApiResponse.successWithNoData());
 	}
 
-	// 알림 삭제 API
+	@AllUser
 	@DeleteMapping("/delete/{alarmId}")
-	public ResponseEntity<ApiResponse<Void>> deleteAlarm(@PathVariable String alarmId, @RequestParam Long userId) {
+	@Operation(summary = "휴지통에서 알림 하나 삭제 API", description = "휴지통에 있는 알림 하나를 삭제합니다.")
+	public ResponseEntity<ApiResponse<Void>> deleteAlarm(@PathVariable String alarmId, @UserId Long userId) {
 
 		alarmService.deleteOneAlarm(alarmId, userId);
 
 		return ResponseEntity.ok(ApiResponse.successWithNoData());
 	}
 
-	// 알림 전체 삭제 API
+	@AllUser
 	@DeleteMapping("/delete")
-	public ResponseEntity<ApiResponse<Void>> deleteAllAlarm(@RequestParam Long userId) {
+	@Operation(summary = "휴지통에서 알림 전체 삭제 API", description = "휴지통에 있는 알림 전체를 삭제합니다.")
+	public ResponseEntity<ApiResponse<Void>> deleteAllAlarm(@UserId Long userId) {
 
 		alarmService.deleteAllAlarm(userId);