From 0a58c268958c297ceb750ac802196c29c1152514 Mon Sep 17 00:00:00 2001 From: hou27 Date: Sat, 2 Jul 2022 21:51:53 +0900 Subject: [PATCH] Rename summary --- src/main/java/com/api/auth/AuthController.java | 6 +++--- src/main/java/com/api/user/UserController.java | 4 ++++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/api/auth/AuthController.java b/src/main/java/com/api/auth/AuthController.java index d8610c2..cc45106 100644 --- a/src/main/java/com/api/auth/AuthController.java +++ b/src/main/java/com/api/auth/AuthController.java @@ -21,19 +21,19 @@ import org.springframework.web.bind.annotation.RestController; public class AuthController { private final AuthService authService; - @Operation(summary = "Sign Up", description = "회원가입 메서드입니다.") + @Operation(summary = "회원가입", description = "회원가입 메서드입니다.") @PostMapping("/signUp") public SignUpRes signUp(@Validated SignUpReq signUpReq) { return authService.signUp(signUpReq); } - @Operation(summary = "Sign In", description = "로그인 메서드입니다.") + @Operation(summary = "로그인", description = "로그인 메서드입니다.") @PostMapping("/signIn") public ResponseEntity signIn(@Validated SignInReq signInReq) { return authService.signIn(signInReq); } - @Operation(summary = "Regenerate Token", description = "토큰을 재발행하는 메서드입니다.") + @Operation(summary = "토큰 재발행", description = "토큰을 재발행하는 메서드입니다.") @PostMapping("/regenerateToken") public ResponseEntity regenerateToken(@Validated RegenerateTokenDto refreshTokenDto) { return authService.regenerateToken(refreshTokenDto); diff --git a/src/main/java/com/api/user/UserController.java b/src/main/java/com/api/user/UserController.java index f769a8b..2691a47 100644 --- a/src/main/java/com/api/user/UserController.java +++ b/src/main/java/com/api/user/UserController.java @@ -3,6 +3,7 @@ package com.api.user; import com.api.exception.UserNotFoundException; import com.api.user.domain.Users; import com.api.user.dtos.ProfileDto.ProfileRes; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import java.util.List; import lombok.RequiredArgsConstructor; @@ -23,6 +24,7 @@ import org.springframework.web.bind.annotation.RestController; public class UserController { private final UserService userService; + @Operation(summary = "유저 개인 프로필", description = "유저 프로필 조회 메서드입니다.") @GetMapping("/profile") public ProfileRes profile(@AuthenticationPrincipal UserDetails userDetails) throws UserNotFoundException { System.out.println("userDetails = " + userDetails); @@ -36,6 +38,7 @@ public class UserController { .build(); } + @Operation(summary = "지정된 유저의 프로필", description = "특정 유저 프로필 조회 메서드입니다.") @GetMapping("/profile/view/{username}") public ProfileRes userProfile(@PathVariable String username) throws UserNotFoundException { Users user = userService.findByName(username) @@ -47,6 +50,7 @@ public class UserController { .build(); } + @Operation(summary = "전체 유저 정보", description = "전체 유저 정보 조회 메서드입니다.") @GetMapping("/userList") public List showUserList() { return userService.findAll();