[Fix] :: controller annotation fix

Team-C0nnect · May 22, 2024 · 04ba2f5 · 04ba2f5
1 parent ec26ab0
commit 04ba2f5
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 43 deletions.
diff --git a/src/main/java/com/project/qvick/domain/auth/client/api/AuthController.java b/src/main/java/com/project/qvick/domain/auth/client/api/AuthController.java
@@ -26,34 +26,34 @@ public class AuthController {
 
     private final AuthService authService;
 
-    @Operation(summary = "유저 회원가입", description = "유저 회원가입")
     @PostMapping("/sign-up")
+    @Operation(summary = "유저 회원가입", description = "유저 회원가입")
     @ResponseStatus(HttpStatus.CREATED)
     public void signUp(@Validated @RequestBody SignUpRequest signUpRequest){
         authService.signUp(signUpRequest);
     }
 
-    @Operation(summary = "관리자 회원가입", description = "관리자 회원가입")
     @PostMapping("/sign-up/admin")
     @ResponseStatus(HttpStatus.CREATED)
+    @Operation(summary = "관리자 회원가입", description = "관리자 회원가입")
     public void adminSignUp(@Validated @RequestBody SignUpRequest signUpRequest){
         authService.adminSignUp(signUpRequest);
     }
 
-    @Operation(summary = "로그인", description = "로그인")
     @PostMapping("/sign-in")
+    @Operation(summary = "로그인", description = "로그인")
     public JsonWebTokenResponse signIn(@Validated @RequestBody SignInRequest signInRequest){
         return authService.signIn(signInRequest);
     }
 
-    @Operation(summary = "토큰 재발급", description = "acess 토큰을 재발급 합니다")
     @PostMapping("/refresh")
+    @Operation(summary = "토큰 재발급", description = "acess 토큰을 재발급 합니다")
     public RefreshTokenResponse refresh(RefreshTokenRequest request){
         return authService.refresh(request.getRefreshToken());
     }
 
-    @Operation(summary = "firebase 인증", description = "firebase 인증 서비스")
     @PostMapping("/firebase")
+    @Operation(summary = "firebase 인증", description = "firebase 인증 서비스")
     public void firebase(AuthenticationRequest request){
         authService.firebase(request);
     }

diff --git a/src/main/java/com/project/qvick/domain/check/client/api/CheckController.java b/src/main/java/com/project/qvick/domain/check/client/api/CheckController.java
@@ -36,28 +36,28 @@ public class CheckController {
     private final CheckQueryService checkQueryService;
     private final CheckCodeService checkCodeService;
 
-    @Operation(summary = "출석 체크", description = "출석 체크")
     @PostMapping("")
+    @Operation(summary = "출석 체크", description = "출석 체크")
     public void attendanceCheck(@RequestBody CodeRequest codeRequest) {
         checkService.attendance(codeRequest);
     }
 
-    @Operation(summary = "출석 명단", description = "출석 명단을 표시합니다")
-    @GetMapping("/list")
-    public ResponseEntity<List<Check>> findCheck(@ModelAttribute PageRequest pageRequest) {
-        return ResponseEntity.status(HttpStatus.OK).body(checkQueryService.findCheck(pageRequest));
-    }
-
-    @Operation(summary = "출석 코드 생성", description = "출석 코드 생성합니다")
     @PostMapping("/code")
+    @Operation(summary = "출석 코드 생성", description = "출석 코드 생성합니다")
     public ResponseEntity<CheckCodeResponse> generateCheckCode() throws ExecutionException, InterruptedException {
         CompletableFuture<CheckCodeResponse> codeResponseFuture = checkCodeService.generate();
         CheckCodeResponse codes = codeResponseFuture.get();
         return ResponseEntity.status(HttpStatus.CREATED).body(codes);
     }
 
-    @Operation(summary = "출석 확인", description = "출석 상태를 확인합니다")
+    @GetMapping("/list")
+    @Operation(summary = "출석 명단", description = "출석 명단을 표시합니다")
+    public ResponseEntity<List<Check>> findCheck(@ModelAttribute PageRequest pageRequest) {
+        return ResponseEntity.status(HttpStatus.OK).body(checkQueryService.findCheck(pageRequest));
+    }
+
     @GetMapping("")
+    @Operation(summary = "출석 확인", description = "출석 상태를 확인합니다")
     public ResponseEntity<Check> attendanceCheck(){
         return checkService.attendanceCheck();
     }

diff --git a/src/main/java/com/project/qvick/domain/outing/client/api/OutingAdminController.java b/src/main/java/com/project/qvick/domain/outing/client/api/OutingAdminController.java
@@ -30,24 +30,24 @@ public class OutingAdminController {
     private final OutingService service;
     private final OutingQueryService queryService;
 
-    @Operation(summary = "외출 승인")
+    @GetMapping("/findStudents")
+    @Operation(summary = "외출 조회", description = "외출 명단을 조회합니다")
+    public ResponseEntity<List<Outing>> findStudents(@ModelAttribute OutingPageRequest request) {
+        return ResponseEntity.ok(queryService.findOutStudents(request));
+    }
+
     @PutMapping("/accept")
     @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "외출 승인", description = "외출을 승인합니다")
     public void acceptSleepover(@RequestBody OutingSettingRequest request) {
         service.accept(request.getOutingId());
     }
 
-    @Operation(summary = "외출 거절")
     @PutMapping("/refuse")
     @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "외출 거절", description = "외출을 거절합니다")
     public void refuseSleepover(@Validated @RequestBody OutingSettingRequest request) {
         service.accept(request.getOutingId());
     }
 
-    @Operation(summary = "외출 조회", description = "외출 명단을 조회합니다")
-    @GetMapping("/findStudents")
-    public ResponseEntity<List<Outing>> findStudents(@ModelAttribute OutingPageRequest request) {
-        return ResponseEntity.ok(queryService.findOutStudents(request));
-    }
-
 }
diff --git a/src/main/java/com/project/qvick/domain/outing/client/api/OutingController.java b/src/main/java/com/project/qvick/domain/outing/client/api/OutingController.java
@@ -2,6 +2,7 @@
 
 import com.project.qvick.domain.outing.client.dto.request.OutingRequest;
 import com.project.qvick.domain.outing.application.service.OutingService;
+import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
@@ -24,6 +25,7 @@ public class OutingController {
 
     @PostMapping("")
     @ResponseStatus(HttpStatus.CREATED)
+    @Operation(summary = "외출 신청", description = "외출을 신청합니다")
     public void register(@Validated @RequestBody OutingRequest request){
         service.register(request.toOuting());
     }

diff --git a/src/main/java/com/project/qvick/domain/school/client/api/SchoolController.java b/src/main/java/com/project/qvick/domain/school/client/api/SchoolController.java
@@ -36,8 +36,8 @@ public void registerSchool(@RequestBody SchoolRequest schoolRequest){
         schoolService.registerSchool(schoolRequest);
     }
 
-    @Operation(summary = "학교 목록", description = "학교 목록을 표시합니다")
     @GetMapping("")
+    @Operation(summary = "학교 목록", description = "학교 목록을 표시합니다")
     public ResponseEntity<List<School>> findCheck(@ModelAttribute PageRequest pageRequest) {
         return ResponseEntity.status(HttpStatus.OK).body(schoolQueryService.schoolList(pageRequest));
     }

diff --git a/src/main/java/com/project/qvick/domain/sleepover/client/api/SleepoverAdminController.java b/src/main/java/com/project/qvick/domain/sleepover/client/api/SleepoverAdminController.java
@@ -30,24 +30,24 @@ public class SleepoverAdminController {
     private final SleepoverService sleepoverService;
     private final SleepoverQueryService querydslService;
 
-    @Operation(summary = "외박 승인")
+    @GetMapping("/findStudents")
+    @Operation(summary = "외박 조회", description = "외박 명단을 조회합니다")
+    public ResponseEntity<List<Sleepover>> findStudents(@ModelAttribute SleepoverPageRequest request) {
+        return ResponseEntity.ok(querydslService.findSleepoverStudents(request));
+    }
+
     @PutMapping("/accept")
     @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "외박 승인", description = "외박을 승인합니다")
     public void acceptSleepover(@RequestBody SleepoverSettingRequest request) {
         sleepoverService.acceptSleepover(request.getSleepoverId());
     }
 
-    @Operation(summary = "외박 거절")
     @PutMapping("/refuse")
     @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "외박 거절", description = "외박을 거절합니다")
     public void refuseSleepover(@Validated @RequestBody SleepoverSettingRequest request) {
         sleepoverService.refuseSleepover(request.getSleepoverId());
     }
 
-    @Operation(summary = "외박 조회", description = "외박 명단을 조회합니다")
-    @GetMapping("/findStudents")
-    public ResponseEntity<List<Sleepover>> findStudents(@ModelAttribute SleepoverPageRequest request) {
-        return ResponseEntity.ok(querydslService.findSleepoverStudents(request));
-    }
-
 }
diff --git a/src/main/java/com/project/qvick/domain/sleepover/client/api/SleepoverController.java b/src/main/java/com/project/qvick/domain/sleepover/client/api/SleepoverController.java
@@ -23,9 +23,9 @@ public class SleepoverController {
 
     private final SleepoverService sleepoverService;
 
-    @Operation(summary = "외박 신청")
     @PostMapping("")
     @ResponseStatus(HttpStatus.CREATED)
+    @Operation(summary = "외박 신청", description = "외박을 신청합니다")
     public void registerSleepover(@Validated @RequestBody SleepoverRequest request){
         sleepoverService.registerSleepover(request.toSleepover());
     }

diff --git a/src/main/java/com/project/qvick/domain/user/client/api/UserAdminController.java b/src/main/java/com/project/qvick/domain/user/client/api/UserAdminController.java
@@ -23,14 +23,14 @@ public class UserAdminController {
 
     private final UserQueryService userQueryService;
 
-    @Operation(summary = "전체 유저 조회", description = "전체 유저를 조회합니다.")
     @GetMapping("/find-all")
+    @Operation(summary = "전체 유저 조회", description = "전체 유저를 조회합니다")
     public ResponseEntity<List<User>>userList(@ModelAttribute PageRequest pageRequest){
         return ResponseEntity.ok(userQueryService.userList(pageRequest));
     }
 
-    @Operation(summary = "유저 검색", description = "특정 유저를 이름을 기준으로 검색합니다.")
     @GetMapping("/search")
+    @Operation(summary = "유저 검색", description = "특정 유저를 이름을 기준으로 검색합니다")
     public ResponseEntity<List<User>>userSearch(@ModelAttribute SearchRequest searchRequest){
         return ResponseEntity.ok(userQueryService.userSearch(searchRequest));
     }

diff --git a/src/main/java/com/project/qvick/domain/user/client/api/UserController.java b/src/main/java/com/project/qvick/domain/user/client/api/UserController.java
@@ -27,30 +27,30 @@ public class UserController {
     private final UserService userService;
     private final UserUtil userUtil;
 
-    @Operation(summary = "회원 학번 수정", description = "회원 학번을 수정합니다")
+    @GetMapping("")
+    @Operation(summary = "유저 조회", description = "현재 로그인한 유저 정보를 조회합니다")
+    public User findUser(){
+        return userUtil.findUser();
+    }
+
     @PatchMapping("/stdId")
+    @Operation(summary = "회원 학번 수정", description = "회원 학번을 수정합니다")
     @ResponseStatus(HttpStatus.OK)
     public void editUser(@Validated @RequestBody StdIdEditRequest request){
         userService.editUserStdId(request);
     }
 
-    @Operation(summary = "회원 호실 수정", description = "회원 호실을 수정합니다")
     @PatchMapping("/room")
     @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "회원 호실 수정", description = "회원 호실을 수정합니다")
     public void editUser(@Validated @RequestBody RoomRequest request){
         userService.editRoom(request);
     }
 
-    @Operation(summary = "회원탈퇴", description = "회원 탈퇴를 진행합니다")
     @DeleteMapping("")
+    @Operation(summary = "회원탈퇴", description = "회원 탈퇴를 진행합니다")
     public void deleteUser(){
         userService.deleteUser();
     }
 
-    @Operation(summary = "유저 조회", description = "현재 로그인한 유저 정보를 조회합니다")
-    @GetMapping("")
-    public User findUser(){
-        return userUtil.findUser();
-    }
-
 }