feature : swagger 추가

Author: minjee2758

src/main/java/org/ezcode/codetest/application/usermanagement/auth/dto/request/LogoutRequest.java

@@ -1,5 +1,6 @@
 package org.ezcode.codetest.application.usermanagement.auth.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.Email;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Pattern;
@@ -10,12 +11,15 @@
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@Schema(description = "로그인 요청")
 public class SigninRequest {
 
+	@Schema(description = "사용자 이메일 주소", example = "[email protected]")
 	@NotBlank
 	@Email(message = "이메일은 공백일 수 없습니다")
 	private String email;
 
+	@Schema(description = "비밀번호 (영문, 숫자, 특수문자 포함 8~20자)", example = "Aa1234**")
 	@NotBlank(message = "비밀번호는 공백일 수 없습니다.")
 	@Pattern(
 		regexp = "^(?=.*[A-Za-z])(?=.*\\d)(?=.*[@$!%*#?&])[A-Za-z\\d@$!%*#?&]{8,20}$",

src/main/java/org/ezcode/codetest/application/usermanagement/auth/dto/request/SigninRequest.java

@@ -1,5 +1,6 @@
 package org.ezcode.codetest.application.usermanagement.auth.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.Email;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Pattern;
@@ -11,30 +12,39 @@
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@Schema(description = "회원가입 요청")
 public class SignupRequest {
 
+	@Schema(description = "유저 이메일", example = "[email protected]")
 	@NotBlank(message = "이메일은 공백일 수 없습니다")
 	@Email
 	private String email;
 
+	@Schema(description = "비밀번호 (영문, 숫자, 특수문자 포함 8~20자)", example = "Aa12345**")
 	@NotBlank(message = "비밀번호는 공백일 수 없습니다.")
 	@Pattern(
 		regexp = "^(?=.*[A-Za-z])(?=.*\\d)(?=.*[@$!%*#?&])[A-Za-z\\d@$!%*#?&]{8,20}$",
 		message = "비밀번호는 영문, 숫자, 특수문자를 포함한 8~20자리여야 합니다.")
 	private String password;
 
+
+	@Schema(description = "비밀번호 확인", example = "Aa12345**")
 	@NotBlank(message = "비밀번호 확인은 공백일 수 없습니다.")
 	private String passwordConfirm;
 
+
+	@Schema(description = "사용자 이름 (최대 15자)", example = "홍길동")
 	@NotBlank(message = "사용자명은 반드시 입력되어야합니다.")
 	@Size(max = 15, message = "이름은 15글자 이하로 입력 가능합니다")
 	private String username;
 
+	@Schema(description = "사용자 별명 (최대 20자)", example = "다람쥐쳇바퀴에굴러가")
 	@NotBlank(message = "별명은 반드시 입력되어야합니다")
 	@Size(max = 20, message = "별명은 20글자 이하로 입력 가능합니다")
 	private String nickname;
 
 	//선택적 입력
+	@Schema(description = "나이 (선택 입력)", example = "25")
 	private Integer age;
 
 }

src/main/java/org/ezcode/codetest/application/usermanagement/auth/dto/request/SignupRequest.java

@@ -1,7 +1,12 @@
 package org.ezcode.codetest.application.usermanagement.auth.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "소셜 로그인 응답")
 public record OAuthResponse(
+	@Schema(description = "accessToken")
 	String accessToken,
+	@Schema(description = "refreshToken")
 	String refreshToken
 ){
 	public static OAuthResponse from(String accessToken, String refreshToken) {

src/main/java/org/ezcode/codetest/application/usermanagement/auth/dto/response/OAuthResponse.java

@@ -1,6 +1,12 @@
 package org.ezcode.codetest.application.usermanagement.auth.dto.response;
 
-public record RefreshTokenResponse (String token) {
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "refreshToken 응답")
+public record RefreshTokenResponse (
+	@Schema(description = "생성된 refreshToken")
+	String token
+) {
 	public static RefreshTokenResponse from(String token) {
 		return new RefreshTokenResponse(token);
 	}

src/main/java/org/ezcode/codetest/application/usermanagement/auth/dto/response/RefreshTokenResponse.java

@@ -1,7 +1,13 @@
 package org.ezcode.codetest.application.usermanagement.auth.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 
-public record SigninResponse(String accessToken, String refreshToken)  {
+@Schema(description = "로그인 응답")
+public record SigninResponse(
+	@Schema(description = "생성된 accessToken")
+	String accessToken,
+	@Schema(description = "생성된 refreshToken")
+	String refreshToken)  {
 	public static SigninResponse from(String accessToken, String refreshToken) {
 		return new SigninResponse(accessToken, refreshToken);
 	}

src/main/java/org/ezcode/codetest/application/usermanagement/auth/dto/response/SigninResponse.java

@@ -1,7 +1,12 @@
 package org.ezcode.codetest.application.usermanagement.auth.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 
-public record SignupResponse(String token) {
+@Schema(description = "회원가입 응답")
+public record SignupResponse(
+	@Schema(description = "생성된 token")
+	String token
+) {
 	public static SignupResponse from(String token) {
 		return new SignupResponse(token);
 	}

src/main/java/org/ezcode/codetest/application/usermanagement/auth/dto/response/SignupResponse.java

@@ -2,7 +2,6 @@
 
 import java.util.concurrent.TimeUnit;
 
-import org.ezcode.codetest.application.usermanagement.auth.dto.request.LogoutRequest;
 import org.ezcode.codetest.application.usermanagement.auth.dto.response.RefreshTokenResponse;
 import org.ezcode.codetest.application.usermanagement.auth.dto.request.SigninRequest;
 import org.ezcode.codetest.application.usermanagement.auth.dto.response.SigninResponse;
@@ -14,7 +13,7 @@
 import org.ezcode.codetest.domain.user.model.entity.User;
 import org.ezcode.codetest.domain.user.model.enums.AuthType;
 import org.ezcode.codetest.domain.user.service.UserDomainService;
-import org.ezcode.codetest.common.security.jwt.JwtUtil;
+import org.ezcode.codetest.common.security.util.JwtUtil;
 import org.springframework.data.redis.core.RedisTemplate;
 import org.springframework.stereotype.Service;
 

src/main/java/org/ezcode/codetest/application/usermanagement/auth/service/AuthService.java

@@ -1,12 +1,17 @@
 package org.ezcode.codetest.application.usermanagement.user.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Pattern;
 
+@Schema(description = "비밀번호 변경 요청")
 public record ChangeUserPasswordRequest(
+
+	@Schema(description = "기존 비밀번호와 일치해야합니다", example = "Aa1234**")
 	@NotBlank
 	String oldPassword,
 
+	@Schema(description = "비밀번호 (영문, 숫자, 특수문자 포함 8~20자)", example = "Aa1234**")
 	@NotBlank(message = "비밀번호는 공백일 수 없습니다.")
 	@Pattern(
 		regexp = "^(?=.*[A-Za-z])(?=.*\\d)(?=.*[@$!%*#?&])[A-Za-z\\d@$!%*#?&]{8,20}$",

src/main/java/org/ezcode/codetest/application/usermanagement/user/dto/request/ChangeUserPasswordRequest.java

@@ -1,16 +1,25 @@
 package org.ezcode.codetest.application.usermanagement.user.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "회원 정보 변경 요청")
 public record ModifyUserInfoRequest(
+	@Schema(description = "변경할 별명", example = "코딩짱")
 	String nickname,
 
+	@Schema(description = "GitHub 주소", example = "https://github.com/username")
 	String githubUrl,
 
+	@Schema(description = "블로그 주소", example = "https://blog.example.com")
 	String blogUrl,
 
+	@Schema(description = "프로필 이미지 URL", example = "https://cdn.example.com/images/profile.jpg")
 	String profileImageUrl,
 
+	@Schema(description = "자기소개", example = "안녕하세요, 백엔드 개발자입니다.")
 	String introduction,
 
+	@Schema(description = "나이", example = "28")
 	Integer age
 ) {
 }