diff --git a/src/main/java/com/travelcompass/api/location/controller/LocationLikeController.java b/src/main/java/com/travelcompass/api/location/controller/LocationLikeController.java index b0d67de..98b2e72 100644 --- a/src/main/java/com/travelcompass/api/location/controller/LocationLikeController.java +++ b/src/main/java/com/travelcompass/api/location/controller/LocationLikeController.java @@ -22,7 +22,7 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; -@Tag(name = "장소 좋아요", description = "장소 좋아요 관련 api 입니다.") +@Tag(name = "장소 좋아요", description = "장소 좋아요 관련 api 입니다. - 양지원") @RestController @RequestMapping("/locations/{location-id}") @RequiredArgsConstructor diff --git a/src/main/java/com/travelcompass/api/oauth/controller/TokenController.java b/src/main/java/com/travelcompass/api/oauth/controller/TokenController.java index b936f13..68066b8 100644 --- a/src/main/java/com/travelcompass/api/oauth/controller/TokenController.java +++ b/src/main/java/com/travelcompass/api/oauth/controller/TokenController.java @@ -1,5 +1,8 @@ package com.travelcompass.api.oauth.controller; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.responses.ApiResponses; +import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestParam; @@ -8,8 +11,14 @@ import java.util.HashMap; import java.util.Map; +@Tag(name = "토큰", description = "access token 관련 api 입니다. - 양지원") @RestController public class TokenController { + + @Operation(summary = "토큰 반환", description = "로컬에서 로그인했을때 토큰 반환받는 메서드입니다.") + @ApiResponses({ + @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON_200", description = "Success"), + }) @GetMapping("/token") public ResponseEntity> tokenPagge( @RequestParam(name = "access-token") String accessToken, diff --git a/src/main/java/com/travelcompass/api/oauth/controller/UserController.java b/src/main/java/com/travelcompass/api/oauth/controller/UserController.java index f0bcf4b..a0ab2b2 100644 --- a/src/main/java/com/travelcompass/api/oauth/controller/UserController.java +++ b/src/main/java/com/travelcompass/api/oauth/controller/UserController.java @@ -3,28 +3,36 @@ import com.travelcompass.api.global.api_payload.ApiResponse; import com.travelcompass.api.global.api_payload.SuccessCode; import com.travelcompass.api.oauth.jwt.JwtDto; -import com.travelcompass.api.oauth.jwt.JwtTokenUtils; import com.travelcompass.api.oauth.service.UserService; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.responses.ApiResponses; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.servlet.http.HttpServletRequest; import lombok.RequiredArgsConstructor; import org.springframework.security.core.Authentication; import org.springframework.web.bind.annotation.*; +@Tag(name = "회원", description = "회원 관련 api 입니다. - 양지원") @RestController @RequiredArgsConstructor @RequestMapping("/users") public class UserController { private final UserService userService; - private final JwtTokenUtils jwtTokenUtils; - // 로그아웃 + @Operation(summary = "로그아웃", description = "로그아웃하는 메서드입니다.") + @ApiResponses({ + @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER_202", description = "로그아웃 되었습니다."), + }) @DeleteMapping("/logout") public ApiResponse logout(HttpServletRequest request) { userService.logout(request); return ApiResponse.onSuccess(SuccessCode.USER_LOGOUT_SUCCESS, 1); } - // 토큰 재발급 + @Operation(summary = "토큰 재발급", description = "토큰을 재발급하는 메서드입니다.") + @ApiResponses({ + @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER_203", description = "토큰 재발급이 완료되었습니다."), + }) @PostMapping("/reissue") public ApiResponse reissue( HttpServletRequest request @@ -33,7 +41,10 @@ public ApiResponse reissue( return ApiResponse.onSuccess(SuccessCode.USER_REISSUE_SUCCESS, jwt); } - // 회원탈퇴 + @Operation(summary = "회원탈퇴", description = "회원 탈퇴하는 메서드입니다.") + @ApiResponses({ + @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER_204", description = "회원탈퇴가 완료되었습니다."), + }) @DeleteMapping("/me") public ApiResponse deleteUser(Authentication auth) { userService.deleteUser(auth.getName()); diff --git a/src/main/java/com/travelcompass/api/plan/controller/PlanLikeController.java b/src/main/java/com/travelcompass/api/plan/controller/PlanLikeController.java index 7c4aaf4..400f1cf 100644 --- a/src/main/java/com/travelcompass/api/plan/controller/PlanLikeController.java +++ b/src/main/java/com/travelcompass/api/plan/controller/PlanLikeController.java @@ -17,7 +17,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; import java.util.List; -@Tag(name = "여행 계획 좋아요", description = "여행 계획 좋아요 관련 api 입니다.") +@Tag(name = "여행 계획 좋아요", description = "여행 계획 좋아요 관련 api 입니다. - 양지원") @RestController @RequestMapping("/plans/{plan-id}") @RequiredArgsConstructor