Skip to content

Commit 211349b

Browse files
committed
Docs: Swagger 문서 작성
1 parent 02ef78a commit 211349b

File tree

3 files changed

+77
-6
lines changed

3 files changed

+77
-6
lines changed

src/main/java/com/back/domain/user/controller/AuthController.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public ResponseEntity<RsData<UserResponse>> verifyEmail(
4949
// 인증 메일 재발송
5050
@PostMapping("/email/verify")
5151
public ResponseEntity<RsData<Void>> resendVerificationEmail(
52-
@Valid @RequestBody sendEmailRequest request
52+
@Valid @RequestBody SendEmailRequest request
5353
) {
5454
authService.resendVerificationEmail(request.email());
5555
return ResponseEntity
@@ -103,7 +103,7 @@ public ResponseEntity<RsData<Map<String, String>>> refreshToken(
103103
// 아이디 찾기
104104
@PostMapping("/username/recover")
105105
public ResponseEntity<RsData<Void>> recoverUsername(
106-
@Valid @RequestBody sendEmailRequest request
106+
@Valid @RequestBody SendEmailRequest request
107107
) {
108108
authService.recoverUsername(request.email());
109109
return ResponseEntity
@@ -116,7 +116,7 @@ public ResponseEntity<RsData<Void>> recoverUsername(
116116
// 비밀번호 재설정 요청
117117
@PostMapping("/password/recover")
118118
public ResponseEntity<RsData<Void>> recoverPassword(
119-
@Valid @RequestBody sendEmailRequest request
119+
@Valid @RequestBody SendEmailRequest request
120120
) {
121121
authService.recoverPassword(request.email());
122122
return ResponseEntity

src/main/java/com/back/domain/user/controller/AuthControllerDocs.java

Lines changed: 73 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ ResponseEntity<RsData<UserResponse>> verifyEmail(
306306
)
307307
})
308308
ResponseEntity<RsData<Void>> resendVerificationEmail(
309-
@Valid @RequestBody sendEmailRequest request
309+
@Valid @RequestBody SendEmailRequest request
310310
);
311311

312312
@Operation(
@@ -760,6 +760,77 @@ ResponseEntity<RsData<Map<String, String>>> refreshToken(
760760
})
761761
@PostMapping("/username/recover")
762762
ResponseEntity<RsData<Void>> recoverUsername(
763-
@Valid @RequestBody sendEmailRequest request
763+
@Valid @RequestBody SendEmailRequest request
764+
);
765+
766+
@Operation(
767+
summary = "비밀번호 재설정 요청",
768+
description = "사용자가 가입한 이메일을 입력하면, 해당 이메일로 비밀번호 재설정 링크가 발송됩니다."
769+
)
770+
@ApiResponses({
771+
@ApiResponse(
772+
responseCode = "200",
773+
description = "비밀번호 재설정 메일 발송 성공",
774+
content = @Content(
775+
mediaType = "application/json",
776+
examples = @ExampleObject(value = """
777+
{
778+
"success": true,
779+
"code": "SUCCESS_200",
780+
"message": "비밀번호 재설정 메일을 전송했습니다.",
781+
"data": null
782+
}
783+
""")
784+
)
785+
),
786+
@ApiResponse(
787+
responseCode = "404",
788+
description = "존재하지 않는 사용자",
789+
content = @Content(
790+
mediaType = "application/json",
791+
examples = @ExampleObject(value = """
792+
{
793+
"success": false,
794+
"code": "USER_001",
795+
"message": "존재하지 않는 사용자입니다.",
796+
"data": null
797+
}
798+
""")
799+
)
800+
),
801+
@ApiResponse(
802+
responseCode = "400",
803+
description = "잘못된 요청 (이메일 누락 등)",
804+
content = @Content(
805+
mediaType = "application/json",
806+
examples = @ExampleObject(value = """
807+
{
808+
"success": false,
809+
"code": "COMMON_400",
810+
"message": "잘못된 요청입니다.",
811+
"data": null
812+
}
813+
""")
814+
)
815+
),
816+
@ApiResponse(
817+
responseCode = "500",
818+
description = "서버 내부 오류",
819+
content = @Content(
820+
mediaType = "application/json",
821+
examples = @ExampleObject(value = """
822+
{
823+
"success": false,
824+
"code": "COMMON_500",
825+
"message": "서버 오류가 발생했습니다.",
826+
"data": null
827+
}
828+
""")
829+
)
830+
)
831+
})
832+
@PostMapping("/password/recover")
833+
ResponseEntity<RsData<Void>> recoverPassword(
834+
@Valid @RequestBody SendEmailRequest request
764835
);
765836
}

src/main/java/com/back/domain/user/dto/sendEmailRequest.java renamed to src/main/java/com/back/domain/user/dto/SendEmailRequest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import jakarta.validation.constraints.Email;
44
import jakarta.validation.constraints.NotBlank;
55

6-
public record sendEmailRequest(
6+
public record SendEmailRequest(
77
@NotBlank @Email String email
88
) {
99
}

0 commit comments

Comments
 (0)