diff --git a/src/main/java/com/uspray/uspray/controller/AuthController.java b/src/main/java/com/uspray/uspray/controller/AuthController.java index 5fc1da02..7fc0eaf9 100644 --- a/src/main/java/com/uspray/uspray/controller/AuthController.java +++ b/src/main/java/com/uspray/uspray/controller/AuthController.java @@ -34,80 +34,80 @@ @RestController @RequestMapping("/auth") @RequiredArgsConstructor -@Tag(name = "회원 관리", description = "Auth 관련 API") +@Tag(name = "Auth", description = "Auth 관련 API") public class AuthController { - private final TokenProvider tokenProvider; - private final AuthService authService; + private final TokenProvider tokenProvider; + private final AuthService authService; - @PostMapping("/signup") - @ApiResponse( - responseCode = "201", - description = "회원가입 성공", - content = @Content(schema = @Schema(implementation = MemberResponseDto.class))) - public ApiResponseDto signup( - @RequestBody @Valid MemberRequestDto memberRequestDto) { - return ApiResponseDto.success(SuccessStatus.SIGNUP_SUCCESS, - authService.signup(memberRequestDto)); - } + @PostMapping("/signup") + @ApiResponse( + responseCode = "201", + description = "회원가입 성공", + content = @Content(schema = @Schema(implementation = MemberResponseDto.class))) + public ApiResponseDto signup( + @RequestBody @Valid MemberRequestDto memberRequestDto) { + return ApiResponseDto.success(SuccessStatus.SIGNUP_SUCCESS, + authService.signup(memberRequestDto)); + } - @PostMapping("/login") - @ApiResponse( - responseCode = "200", - description = "로그인 성공", - content = @Content(schema = @Schema(implementation = MemberResponseDto.class))) - public ApiResponseDto login( - @RequestBody MemberLoginRequestDto memberLoginRequestDto) { - return ApiResponseDto.success(SuccessStatus.LOGIN_SUCCESS, - authService.login(memberLoginRequestDto)); - } + @PostMapping("/login") + @ApiResponse( + responseCode = "200", + description = "로그인 성공", + content = @Content(schema = @Schema(implementation = MemberResponseDto.class))) + public ApiResponseDto login( + @RequestBody MemberLoginRequestDto memberLoginRequestDto) { + return ApiResponseDto.success(SuccessStatus.LOGIN_SUCCESS, + authService.login(memberLoginRequestDto)); + } - @PostMapping("/reissue") - @ApiResponse( - responseCode = "200", - description = "토큰 재발급 성공", - content = @Content(schema = @Schema(implementation = TokenDto.class))) - @SecurityRequirements({ - @SecurityRequirement(name = "JWT Auth"), - @SecurityRequirement(name = "Refresh") - }) - public ApiResponseDto reissue(@Parameter(hidden = true) HttpServletRequest request) { - String accessToken = request.getHeader("Authorization").substring(7); - String refreshToken = request.getHeader("Refresh"); - return ApiResponseDto.success(SuccessStatus.REISSUE_SUCCESS, - authService.reissue(accessToken, refreshToken)); - } + @PostMapping("/reissue") + @ApiResponse( + responseCode = "200", + description = "토큰 재발급 성공", + content = @Content(schema = @Schema(implementation = TokenDto.class))) + @SecurityRequirements({ + @SecurityRequirement(name = "JWT Auth"), + @SecurityRequirement(name = "Refresh") + }) + public ApiResponseDto reissue(@Parameter(hidden = true) HttpServletRequest request) { + String accessToken = request.getHeader("Authorization").substring(7); + String refreshToken = request.getHeader("Refresh"); + return ApiResponseDto.success(SuccessStatus.REISSUE_SUCCESS, + authService.reissue(accessToken, refreshToken)); + } - @PostMapping("/find-id") - @Operation(summary = "아이디 찾기") - public ApiResponseDto findId(@RequestBody FindIdDto findIdDto) { - return ApiResponseDto.success(SuccessStatus.FIND_USER_ID_SUCCESS, - authService.findId(findIdDto)); - } + @PostMapping("/find-id") + @Operation(summary = "아이디 찾기") + public ApiResponseDto findId(@RequestBody FindIdDto findIdDto) { + return ApiResponseDto.success(SuccessStatus.FIND_USER_ID_SUCCESS, + authService.findId(findIdDto)); + } - @PostMapping("/find-pw") - @Operation(summary = "비밀번호 찾기") - public ApiResponseDto findId(@RequestBody FindPwDto findPwDto) { - authService.findPw(findPwDto); - return ApiResponseDto.success(SuccessStatus.CHANGE_USER_PW_SUCCESS); - } + @PostMapping("/find-pw") + @Operation(summary = "비밀번호 찾기") + public ApiResponseDto findId(@RequestBody FindPwDto findPwDto) { + authService.findPw(findPwDto); + return ApiResponseDto.success(SuccessStatus.CHANGE_USER_PW_SUCCESS); + } - @PostMapping("/withdrawal") - @Operation(summary = "회원 탈퇴") - @SecurityRequirement(name = "JWT Auth") - public ApiResponseDto withdrawal( - @Parameter(hidden = true) @AuthenticationPrincipal User user, - @RequestBody MemberDeleteDto memberDeleteDto) { - authService.withdrawal(user.getUsername(), memberDeleteDto); - return ApiResponseDto.success(SuccessStatus.WITHDRAWAL_SUCCESS); - } + @PostMapping("/withdrawal") + @Operation(summary = "회원 탈퇴") + @SecurityRequirement(name = "JWT Auth") + public ApiResponseDto withdrawal( + @Parameter(hidden = true) @AuthenticationPrincipal User user, + @RequestBody MemberDeleteDto memberDeleteDto) { + authService.withdrawal(user.getUsername(), memberDeleteDto); + return ApiResponseDto.success(SuccessStatus.WITHDRAWAL_SUCCESS); + } - @GetMapping("/dup-check/{userId}") - @Operation(summary = "아이디 중복 체크") - public ApiResponseDto dupCheck(@PathVariable("userId") String userId) { - authService.dupCheck(userId); - return ApiResponseDto.success(SuccessStatus.CHECK_USER_ID_SUCCESS); + @GetMapping("/dup-check/{userId}") + @Operation(summary = "아이디 중복 체크") + public ApiResponseDto dupCheck(@PathVariable("userId") String userId) { + authService.dupCheck(userId); + return ApiResponseDto.success(SuccessStatus.CHECK_USER_ID_SUCCESS); - } + } } diff --git a/src/main/java/com/uspray/uspray/controller/CategoryController.java b/src/main/java/com/uspray/uspray/controller/CategoryController.java index 65bf15b1..ef656d13 100644 --- a/src/main/java/com/uspray/uspray/controller/CategoryController.java +++ b/src/main/java/com/uspray/uspray/controller/CategoryController.java @@ -26,62 +26,62 @@ @RestController @RequestMapping("/category") -@Tag(name = "Category API", description = "Category 관련 API") +@Tag(name = "Category", description = "Category 관련 API") @RequiredArgsConstructor @SecurityRequirement(name = "JWT Auth") public class CategoryController { - private final CategoryService categoryService; + private final CategoryService categoryService; - @Operation(summary = "카테고리 조회") - @ApiResponse( - responseCode = "200", - description = "카테고리 조회", - content = @Content(schema = @Schema(implementation = CategoryResponseDto.class))) - @PostMapping("/{categoryId}") - public ApiResponseDto getCategory( - @Parameter(hidden = true) @AuthenticationPrincipal User user, - @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId - ) { - return ApiResponseDto.success(SuccessStatus.GET_CATEGORY_SUCCESS, - categoryService.getCategory(user.getUsername(), categoryId)); - } + @Operation(summary = "카테고리 조회") + @ApiResponse( + responseCode = "200", + description = "카테고리 조회", + content = @Content(schema = @Schema(implementation = CategoryResponseDto.class))) + @PostMapping("/{categoryId}") + public ApiResponseDto getCategory( + @Parameter(hidden = true) @AuthenticationPrincipal User user, + @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId + ) { + return ApiResponseDto.success(SuccessStatus.GET_CATEGORY_SUCCESS, + categoryService.getCategory(user.getUsername(), categoryId)); + } - @Operation(summary = "카테고리 생성") - @ApiResponse( - responseCode = "201", - description = "카테고리 생성", - content = @Content(schema = @Schema(implementation = CategoryResponseDto.class))) - @PostMapping() - public ApiResponseDto createCategory( - @Parameter(hidden = true) @AuthenticationPrincipal User user, - @RequestBody @Valid CategoryRequestDto categoryRequestDto - ) { - return ApiResponseDto.success(SuccessStatus.CREATE_CATEGORY_SUCCESS, - categoryService.createCategory(user.getUsername(), categoryRequestDto)); - } + @Operation(summary = "카테고리 생성") + @ApiResponse( + responseCode = "201", + description = "카테고리 생성", + content = @Content(schema = @Schema(implementation = CategoryResponseDto.class))) + @PostMapping() + public ApiResponseDto createCategory( + @Parameter(hidden = true) @AuthenticationPrincipal User user, + @RequestBody @Valid CategoryRequestDto categoryRequestDto + ) { + return ApiResponseDto.success(SuccessStatus.CREATE_CATEGORY_SUCCESS, + categoryService.createCategory(user.getUsername(), categoryRequestDto)); + } - @DeleteMapping("/{categoryId}") - public ApiResponseDto deleteCategory( - @Parameter(hidden = true) @AuthenticationPrincipal User user, - @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId - ) { - return ApiResponseDto.success(SuccessStatus.DELETE_CATEGORY_SUCCESS, - categoryService.deleteCategory(user.getUsername(), categoryId)); - } + @DeleteMapping("/{categoryId}") + public ApiResponseDto deleteCategory( + @Parameter(hidden = true) @AuthenticationPrincipal User user, + @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId + ) { + return ApiResponseDto.success(SuccessStatus.DELETE_CATEGORY_SUCCESS, + categoryService.deleteCategory(user.getUsername(), categoryId)); + } - @PutMapping("/{categoryId}") - @ApiResponse( - responseCode = "200", - description = "카테고리 수정", - content = @Content(schema = @Schema(implementation = CategoryResponseDto.class))) - @Operation(summary = "카테고리 수정") - public ApiResponseDto updatePray( - @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId, - @RequestBody @Valid CategoryRequestDto categoryRequestDto, - @Parameter(hidden = true) @AuthenticationPrincipal User user - ) { - return ApiResponseDto.success(SuccessStatus.UPDATE_CATEGORY_SUCCESS, - categoryService.updateCategory(user.getUsername(), categoryId, categoryRequestDto)); - } + @PutMapping("/{categoryId}") + @ApiResponse( + responseCode = "200", + description = "카테고리 수정", + content = @Content(schema = @Schema(implementation = CategoryResponseDto.class))) + @Operation(summary = "카테고리 수정") + public ApiResponseDto updatePray( + @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId, + @RequestBody @Valid CategoryRequestDto categoryRequestDto, + @Parameter(hidden = true) @AuthenticationPrincipal User user + ) { + return ApiResponseDto.success(SuccessStatus.UPDATE_CATEGORY_SUCCESS, + categoryService.updateCategory(user.getUsername(), categoryId, categoryRequestDto)); + } } diff --git a/src/main/java/com/uspray/uspray/controller/GroupPrayController.java b/src/main/java/com/uspray/uspray/controller/GroupPrayController.java index 962af30f..59052608 100644 --- a/src/main/java/com/uspray/uspray/controller/GroupPrayController.java +++ b/src/main/java/com/uspray/uspray/controller/GroupPrayController.java @@ -28,7 +28,7 @@ @RestController @RequestMapping("/grouppray") -@Tag(name = "GroupPray", description = "모임 기도제목 API") +@Tag(name = "Group pray", description = "모임 기도제목 API") @RequiredArgsConstructor @SecurityRequirement(name = "JWT Auth") public class GroupPrayController { diff --git a/src/main/java/com/uspray/uspray/controller/MemberController.java b/src/main/java/com/uspray/uspray/controller/MemberController.java index 60e855d9..626bf44b 100644 --- a/src/main/java/com/uspray/uspray/controller/MemberController.java +++ b/src/main/java/com/uspray/uspray/controller/MemberController.java @@ -1,7 +1,7 @@ package com.uspray.uspray.controller; -import com.uspray.uspray.DTO.notification.NotificationAgreeDto; import com.uspray.uspray.DTO.ApiResponseDto; +import com.uspray.uspray.DTO.notification.NotificationAgreeDto; import com.uspray.uspray.exception.SuccessStatus; import com.uspray.uspray.service.MemberService; import io.swagger.v3.oas.annotations.Operation; @@ -22,7 +22,7 @@ @RequiredArgsConstructor @RequestMapping("/member") @SecurityRequirement(name = "JWT Auth") -@Tag(name = "Member API", description = "유저 관련 api") +@Tag(name = "Member", description = "유저 관련 api") public class MemberController { private final MemberService memberService; diff --git a/src/main/java/com/uspray/uspray/controller/ShareController.java b/src/main/java/com/uspray/uspray/controller/ShareController.java index d6eb9372..ec238d28 100644 --- a/src/main/java/com/uspray/uspray/controller/ShareController.java +++ b/src/main/java/com/uspray/uspray/controller/ShareController.java @@ -31,63 +31,63 @@ @RequestMapping("/share") @RequiredArgsConstructor @SecurityRequirement(name = "JWT Auth") -@Tag(name = "shared pray", description = "기도제목 공유 관련 API") +@Tag(name = "Shared pray", description = "기도제목 공유 관련 API") public class ShareController { - private final ShareService shareService; + private final ShareService shareService; - @GetMapping() - @ApiResponse( - responseCode = "200", - description = "공유받은 기도제목 조회 (보관함 조회)", - content = @Content(schema = @Schema(implementation = SharedPrayListResponseDto.class)) - ) - @Operation(summary = "공유받은 기도제목 조회 (보관함 조회)") - public ApiResponseDto> getSharedPrayList( - @Parameter(hidden = true) @AuthenticationPrincipal User user) { - return ApiResponseDto.success(SuccessStatus.GET_PRAY_LIST_SUCCESS, - shareService.getSharedPrayList(user.getUsername())); - } + @GetMapping() + @ApiResponse( + responseCode = "200", + description = "공유받은 기도제목 조회 (보관함 조회)", + content = @Content(schema = @Schema(implementation = SharedPrayListResponseDto.class)) + ) + @Operation(summary = "공유받은 기도제목 조회 (보관함 조회)") + public ApiResponseDto> getSharedPrayList( + @Parameter(hidden = true) @AuthenticationPrincipal User user) { + return ApiResponseDto.success(SuccessStatus.GET_PRAY_LIST_SUCCESS, + shareService.getSharedPrayList(user.getUsername())); + } - @PostMapping() - @ApiResponse( - responseCode = "201", - description = "기도제목 공유", - content = @Content(schema = @Schema(implementation = PrayResponseDto.class)) - ) - @Operation(summary = "기도제목 공유") - public ApiResponseDto sharePray( - @Parameter(hidden = true) @AuthenticationPrincipal User user, - @RequestBody SharedPrayRequestDto sharedPrayRequestDto) { - shareService.sharePray(user.getUsername(), sharedPrayRequestDto); - return ApiResponseDto.success(SuccessStatus.SHARE_PRAY_SUCCESS); - } + @PostMapping() + @ApiResponse( + responseCode = "201", + description = "기도제목 공유", + content = @Content(schema = @Schema(implementation = PrayResponseDto.class)) + ) + @Operation(summary = "기도제목 공유") + public ApiResponseDto sharePray( + @Parameter(hidden = true) @AuthenticationPrincipal User user, + @RequestBody SharedPrayRequestDto sharedPrayRequestDto) { + shareService.sharePray(user.getUsername(), sharedPrayRequestDto); + return ApiResponseDto.success(SuccessStatus.SHARE_PRAY_SUCCESS); + } - @DeleteMapping() - @ApiResponse( - responseCode = "204", - description = "공유받은 기도제목 삭제", - content = @Content(schema = @Schema(implementation = PrayResponseDto.class)) - ) - @Operation(summary = "공유받은 기도제목 삭제") - public ApiResponseDto deletePray( - @Parameter(hidden = true) @AuthenticationPrincipal User user, - @RequestParam Long sharedPrayId) { - shareService.deleteSharedPray(user.getUsername(), sharedPrayId); - return ApiResponseDto.success(SuccessStatus.DELETE_PRAY_SUCCESS); - } + @DeleteMapping() + @ApiResponse( + responseCode = "204", + description = "공유받은 기도제목 삭제", + content = @Content(schema = @Schema(implementation = PrayResponseDto.class)) + ) + @Operation(summary = "공유받은 기도제목 삭제") + public ApiResponseDto deletePray( + @Parameter(hidden = true) @AuthenticationPrincipal User user, + @RequestParam Long sharedPrayId) { + shareService.deleteSharedPray(user.getUsername(), sharedPrayId); + return ApiResponseDto.success(SuccessStatus.DELETE_PRAY_SUCCESS); + } - @PostMapping("/save") - @ApiResponse( - responseCode = "201", - description = "공유받은 기도제목 저장", - content = @Content(schema = @Schema(implementation = PrayResponseDto.class)) - ) - @Operation(summary = "공유받은 기도제목 저장") - public ApiResponseDto savePray( - @Parameter(hidden = true) @AuthenticationPrincipal User user, - @RequestParam Long sharedPrayId) { - shareService.saveSharedPray(user.getUsername(), sharedPrayId); - return ApiResponseDto.success(SuccessStatus.SHARE_PRAY_AGREE_SUCCESS); - } + @PostMapping("/save") + @ApiResponse( + responseCode = "201", + description = "공유받은 기도제목 저장", + content = @Content(schema = @Schema(implementation = PrayResponseDto.class)) + ) + @Operation(summary = "공유받은 기도제목 저장") + public ApiResponseDto savePray( + @Parameter(hidden = true) @AuthenticationPrincipal User user, + @RequestParam Long sharedPrayId) { + shareService.saveSharedPray(user.getUsername(), sharedPrayId); + return ApiResponseDto.success(SuccessStatus.SHARE_PRAY_AGREE_SUCCESS); + } }