diff --git a/src/main/java/com/helpmeCookies/user/controller/ArtistController.java b/src/main/java/com/helpmeCookies/user/controller/ArtistController.java index 8640807..607f425 100644 --- a/src/main/java/com/helpmeCookies/user/controller/ArtistController.java +++ b/src/main/java/com/helpmeCookies/user/controller/ArtistController.java @@ -15,16 +15,19 @@ import com.helpmeCookies.user.dto.response.ArtistDetailsRes; import com.helpmeCookies.user.service.ArtistService; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; @RestController @RequiredArgsConstructor +@Tag(name = "작가 관련 기능", description = "작가 관련 API") public class ArtistController { private final ArtistService artistService; private final JwtProvider jwtProvider; - // 작가 등록(학생) + @Operation(summary = "학생 작가 등록", description = "학생 작가 등록") @PostMapping("/v1/artists/students") public ResponseEntity registerStudents( @RequestBody StudentArtistReq artistDetailsReq, @@ -34,7 +37,7 @@ public ResponseEntity registerStudents( return ResponseEntity.ok().build(); } - // 작가 등록(사업자) + @Operation(summary = "사업자 작가 등록", description = "사업자 작가 등록") @PostMapping("/v1/artists/bussinesses") public ResponseEntity registerbussinsess( @RequestBody BusinessArtistReq businessArtistReq, @@ -44,14 +47,7 @@ public ResponseEntity registerbussinsess( return ResponseEntity.ok().build(); } - // 작가 목록 조회(페이징) - // TODO: 6주차 회의 이후 추가 - @GetMapping("/v1/artists") - public String getArtists() { - return "ok"; - } - - // 작가 프로필 조회 + @Operation(summary = "작가 프로필 조회", description = "작가 프로필 조회") @GetMapping("/v1/artists/{userId}") public ArtistDetailsRes getArtist( @AuthenticationPrincipal JwtUser jwtUser, @@ -60,7 +56,7 @@ public ArtistDetailsRes getArtist( return artistService.getArtistDetails(userId); } - // 자기 자신 작가 프로필 조회 + @Operation(summary = "작가 프로필 조회", description = "자신의 작가 프로필 조회") @GetMapping("/v1/artist") public ArtistDetailsRes getArtist( @AuthenticationPrincipal JwtUser jwtUser diff --git a/src/main/java/com/helpmeCookies/user/controller/UserController.java b/src/main/java/com/helpmeCookies/user/controller/UserController.java index ead4878..dbbe184 100644 --- a/src/main/java/com/helpmeCookies/user/controller/UserController.java +++ b/src/main/java/com/helpmeCookies/user/controller/UserController.java @@ -23,15 +23,18 @@ import com.helpmeCookies.user.dto.response.UserFollowingRes; import com.helpmeCookies.user.service.UserService; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; @RestController @RequiredArgsConstructor +@Tag(name = "유저 및 팔로우 기능", description = "유저 및 팔로우 기능과 관련된 API") public class UserController { private final UserService userService; - // 유저 일반 정보 조회 + @Operation(summary = "유저 일반 정보 조회", description = "로그인한 유저의 username, imageUrl, hashtag를 조회한다.") @GetMapping("/v1/users") public UserCommonInfoRes getUsers( @AuthenticationPrincipal JwtUser jwtUser @@ -40,6 +43,7 @@ public UserCommonInfoRes getUsers( } // 유저 상세 정보 조회 + @Operation(summary = "유저 상세 정보 조회", description = "로그인한 유저의 이름, 주소를 비롯한 개인정보를 함께 조회한다.") @GetMapping("/v1/users/details") public UserDetailsInfoRes getUserDetails( @AuthenticationPrincipal JwtUser jwtUser @@ -48,6 +52,7 @@ public UserDetailsInfoRes getUserDetails( } // 유저 타입 조회 + @Operation(summary = "유저 타입 조회", description = "로그인한 유저의 타입과 권한을 조회한다.") @GetMapping("/v1/users/type") public UserTypeDto getUserType( @AuthenticationPrincipal JwtUser jwtUser @@ -56,6 +61,7 @@ public UserTypeDto getUserType( } // 유저 정보 수정 + @Operation(summary = "유저 정보 수정", description = "로그인한 유저의 개인정보를 수정한다.") @PutMapping("/v1/users") public String updateUserInfo( @AuthenticationPrincipal JwtUser jwtUser, @@ -66,7 +72,7 @@ public String updateUserInfo( return "ok"; } - // 아티스트 팔로우하기 + @Operation(summary = "아티스트 팔로우하기", description = "로그인한 유저가 특정 아티스트를 팔로우한다.") @PostMapping("/v1/users/following/{artistId}") public String followArtist( @AuthenticationPrincipal JwtUser jwtUser, @@ -76,7 +82,7 @@ public String followArtist( return "ok"; } - // 아티스트 팔로우 취소하기 + @Operation(summary = "아티스트 팔로우 취소하기", description = "로그인한 유저가 특정 아티스트를 팔로우 취소한다.") @DeleteMapping("/v1/users/following/{artistId}") public String unfollowArtist( @AuthenticationPrincipal JwtUser jwtUser, @@ -86,7 +92,7 @@ public String unfollowArtist( return "ok"; } - // 유저 팔로우 목록 조회 + @Operation(summary = "팔로잉 목록 조회", description = "로그인한 유저의 팔로우한 아티스트 목록을 조회한다.") @GetMapping("/v1/users/following") public Page getFollowingList( @AuthenticationPrincipal JwtUser jwtUser, @@ -96,6 +102,7 @@ public Page getFollowingList( } // 유저 탈퇴 + @Operation(summary = "유저 탈퇴", description = "로그인한 유저의 정보를 삭제한다.") @DeleteMapping("/v1/users") public String deleteUser( @AuthenticationPrincipal JwtUser jwtUser