Skip to content

Commit 4c8b11b

Browse files
authored
docs : Swagger 추가 및 리팩토링 (#55)
* refactor : jwt implements 삭제, infra에 있던 security패키지를 common으로 이동 * refactor : FilterConfig를 SecurityConfig 내부에 위치 * feature : swagger 추가
1 parent 359c4e1 commit 4c8b11b

34 files changed

+192
-155
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
package org.ezcode.codetest.application.usermanagement.auth.dto.signin;
1+
package org.ezcode.codetest.application.usermanagement.auth.dto.request;
22

3+
import io.swagger.v3.oas.annotations.media.Schema;
34
import jakarta.validation.constraints.Email;
45
import jakarta.validation.constraints.NotBlank;
56
import jakarta.validation.constraints.Pattern;
6-
import jakarta.validation.constraints.Size;
77
import lombok.AllArgsConstructor;
88
import lombok.Getter;
99
import lombok.NoArgsConstructor;
1010

1111
@Getter
1212
@NoArgsConstructor
1313
@AllArgsConstructor
14+
@Schema(description = "로그인 요청")
1415
public class SigninRequest {
1516

17+
@Schema(description = "사용자 이메일 주소", example = "[email protected]")
1618
@NotBlank
1719
@Email(message = "이메일은 공백일 수 없습니다")
1820
private String email;
1921

22+
@Schema(description = "비밀번호 (영문, 숫자, 특수문자 포함 8~20자)", example = "Aa1234**")
2023
@NotBlank(message = "비밀번호는 공백일 수 없습니다.")
2124
@Pattern(
2225
regexp = "^(?=.*[A-Za-z])(?=.*\\d)(?=.*[@$!%*#?&])[A-Za-z\\d@$!%*#?&]{8,20}$",

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
package org.ezcode.codetest.application.usermanagement.auth.dto.signup;
1+
package org.ezcode.codetest.application.usermanagement.auth.dto.request;
22

3+
import io.swagger.v3.oas.annotations.media.Schema;
34
import jakarta.validation.constraints.Email;
45
import jakarta.validation.constraints.NotBlank;
56
import jakarta.validation.constraints.Pattern;
@@ -11,30 +12,39 @@
1112
@Getter
1213
@NoArgsConstructor
1314
@AllArgsConstructor
15+
@Schema(description = "회원가입 요청")
1416
public class SignupRequest {
1517

18+
@Schema(description = "유저 이메일", example = "[email protected]")
1619
@NotBlank(message = "이메일은 공백일 수 없습니다")
1720
@Email
1821
private String email;
1922

23+
@Schema(description = "비밀번호 (영문, 숫자, 특수문자 포함 8~20자)", example = "Aa12345**")
2024
@NotBlank(message = "비밀번호는 공백일 수 없습니다.")
2125
@Pattern(
2226
regexp = "^(?=.*[A-Za-z])(?=.*\\d)(?=.*[@$!%*#?&])[A-Za-z\\d@$!%*#?&]{8,20}$",
2327
message = "비밀번호는 영문, 숫자, 특수문자를 포함한 8~20자리여야 합니다.")
2428
private String password;
2529

30+
31+
@Schema(description = "비밀번호 확인", example = "Aa12345**")
2632
@NotBlank(message = "비밀번호 확인은 공백일 수 없습니다.")
2733
private String passwordConfirm;
2834

35+
36+
@Schema(description = "사용자 이름 (최대 15자)", example = "홍길동")
2937
@NotBlank(message = "사용자명은 반드시 입력되어야합니다.")
3038
@Size(max = 15, message = "이름은 15글자 이하로 입력 가능합니다")
3139
private String username;
3240

41+
@Schema(description = "사용자 별명 (최대 20자)", example = "다람쥐쳇바퀴에굴러가")
3342
@NotBlank(message = "별명은 반드시 입력되어야합니다")
3443
@Size(max = 20, message = "별명은 20글자 이하로 입력 가능합니다")
3544
private String nickname;
3645

3746
//선택적 입력
47+
@Schema(description = "나이 (선택 입력)", example = "25")
3848
private Integer age;
3949

4050
}

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
package org.ezcode.codetest.application.usermanagement.auth.dto.signin;
1+
package org.ezcode.codetest.application.usermanagement.auth.dto.response;
22

3+
import io.swagger.v3.oas.annotations.media.Schema;
4+
5+
@Schema(description = "소셜 로그인 응답")
36
public record OAuthResponse(
7+
@Schema(description = "accessToken")
48
String accessToken,
9+
@Schema(description = "refreshToken")
510
String refreshToken
611
){
712
public static OAuthResponse from(String accessToken, String refreshToken) {
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package org.ezcode.codetest.application.usermanagement.auth.dto.response;
2+
3+
import io.swagger.v3.oas.annotations.media.Schema;
4+
5+
@Schema(description = "refreshToken 응답")
6+
public record RefreshTokenResponse (
7+
@Schema(description = "생성된 refreshToken")
8+
String token
9+
) {
10+
public static RefreshTokenResponse from(String token) {
11+
return new RefreshTokenResponse(token);
12+
}
13+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
package org.ezcode.codetest.application.usermanagement.auth.dto.response;
2+
3+
import io.swagger.v3.oas.annotations.media.Schema;
4+
5+
@Schema(description = "로그인 응답")
6+
public record SigninResponse(
7+
@Schema(description = "생성된 accessToken")
8+
String accessToken,
9+
@Schema(description = "생성된 refreshToken")
10+
String refreshToken) {
11+
public static SigninResponse from(String accessToken, String refreshToken) {
12+
return new SigninResponse(accessToken, refreshToken);
13+
}
14+
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package org.ezcode.codetest.application.usermanagement.auth.dto.response;
2+
3+
import io.swagger.v3.oas.annotations.media.Schema;
4+
5+
@Schema(description = "회원가입 응답")
6+
public record SignupResponse(
7+
@Schema(description = "생성된 token")
8+
String token
9+
) {
10+
public static SignupResponse from(String token) {
11+
return new SignupResponse(token);
12+
}
13+
}

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

Lines changed: 0 additions & 7 deletions
This file was deleted.

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

Lines changed: 0 additions & 8 deletions
This file was deleted.

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

Lines changed: 0 additions & 8 deletions
This file was deleted.

src/main/java/org/ezcode/codetest/application/usermanagement/auth/port/JwtUtil.java

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)