Feat: 일부 API Path 수정

[dungbik]

📝 변경 내용

---

✅ 체크리스트

• 코드가 정상적으로 동작함
• 테스트 코드 통과함
• 문서(README 등)를 최신화함
• 코드 스타일 가이드 준수

---

💬 기타 참고 사항

Summary by CodeRabbit

• Refactor
  • 이메일 인증 및 비밀번호 재설정 관련 API 경로와 요청 방식이 더 명확하게 변경되었습니다.
  • 이메일 인증 확인 요청 모델 및 관련 명칭이 일관성 있게 수정되었습니다.
  • 비밀번호 재설정 요청 방식이 PATCH에서 POST로 변경되었습니다.

[coderabbitai]

Walkthrough

이 변경은 인증 컨트롤러의 이메일 인증 및 비밀번호 재설정 관련 엔드포인트 경로, 요청 모델, 그리고 서비스 메서드명을 보다 명확하게 리팩토링합니다. 주요 변경점은 경로 및 메서드명/모델명 일관성 확보와 PATCH → POST 방식 전환 등입니다.

Changes

Cohort / File(s)	Change Summary
AuthController 엔드포인트 리팩토링 src/main/java/project/flipnote/auth/controller/AuthController.java	이메일 인증, 이메일 인증 확인, 비밀번호 재설정 요청 및 처리 엔드포인트의 경로, HTTP 메서드, 요청 모델, 서비스 메서드명을 일관성 있게 변경.
API 문서 인터페이스 반영 src/main/java/project/flipnote/auth/controller/docs/AuthControllerDocs.java	이메일 인증 확인 메서드명 및 파라미터 타입을 새 모델명(EmailVerifyRequest)에 맞게 변경.
요청 모델명 변경 src/main/java/project/flipnote/auth/model/EmailVerifyRequest.java	기존 EmailVerificationConfirmRequest를 EmailVerifyRequest로 파일 및 레코드명 변경.
서비스 메서드명 및 파라미터 변경 src/main/java/project/flipnote/auth/service/AuthService.java	이메일 인증 확인 메서드명 및 파라미터 타입을 새 모델명(EmailVerifyRequest)에 맞게 변경. 내부 로직은 동일.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AuthController
    participant AuthService

    Client->>AuthController: POST /email-verification/request (EmailVerificationRequest)
    AuthController->>AuthService: sendEmailVerificationCode(req)
    AuthService-->>AuthController: (void)
    AuthController-->>Client: 204 No Content

    Client->>AuthController: POST /email-verification (EmailVerifyRequest)
    AuthController->>AuthService: verifyEmail(req)
    AuthService-->>AuthController: (void)
    AuthController-->>Client: 204 No Content

    Client->>AuthController: POST /password-reset/request (PasswordResetCreateRequest)
    AuthController->>AuthService: requestPasswordReset(req)
    AuthService-->>AuthController: (void)
    AuthController-->>Client: 204 No Content

    Client->>AuthController: POST /password-reset (PasswordResetRequest)
    AuthController->>AuthService: resetPassword(req)
    AuthService-->>AuthController: (void)
    AuthController-->>Client: 204 No Content

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Feat: [FN-66] 비밀번호 재설정 #15: 비밀번호 재설정 PATCH 엔드포인트 및 관련 서비스/레포지토리 메서드 도입. 이번 PR은 해당 코드에 직접적으로 기반하여 엔드포인트 및 메서드명을 리팩토링함.

Suggested reviewers

• stoneTiger0912

Poem

🐇
경로와 이름을 깔끔히,
인증의 길도 똑바로!
PATCH에서 POST로,
요청 모델도 새롭게,
FlipNote의 인증, 한층 더 또렷하게.
깡총깡총 코딩의 숲에서,
오늘도 변화는 즐겁다!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d69f17 and 0f388b4.

📒 Files selected for processing (4)

• src/main/java/project/flipnote/auth/controller/AuthController.java (4 hunks)
• src/main/java/project/flipnote/auth/controller/docs/AuthControllerDocs.java (2 hunks)
• src/main/java/project/flipnote/auth/model/EmailVerifyRequest.java (1 hunks)
• src/main/java/project/flipnote/auth/service/AuthService.java (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

src/main/java/project/flipnote/auth/model/EmailVerifyRequest.java (2)

src/main/java/project/flipnote/auth/model/EmailVerificationConfirmRequest.java (1)

• EmailVerificationConfirmRequest (8-17)

src/main/java/project/flipnote/auth/model/EmailVerificationRequest.java (1)

• EmailVerificationRequest (6-11)

src/main/java/project/flipnote/auth/service/AuthService.java (2)

src/test/java/project/flipnote/auth/service/AuthServiceTest.java (2)

• ConfirmEmailVerificationCode (132-184)
• success (136-148)

src/main/java/project/flipnote/auth/model/EmailVerificationConfirmRequest.java (1)

• EmailVerificationConfirmRequest (8-17)

🔇 Additional comments (10)

src/main/java/project/flipnote/auth/model/EmailVerifyRequest.java (1)

8-8: 명명 개선으로 인한 긍정적인 변경사항입니다.

EmailVerificationConfirmRequest에서 EmailVerifyRequest로의 이름 변경은 더 간결하고 명확합니다. 기능적으로는 동일하며 전체 코드베이스에서 일관성 있게 적용되었습니다.

src/main/java/project/flipnote/auth/controller/docs/AuthControllerDocs.java (2)

8-8: import 문 업데이트가 올바르게 적용되었습니다.

새로운 모델 클래스명에 맞춰 import가 정확히 업데이트되었습니다.

---

34-34: 메서드명 변경이 일관성 있게 적용되었습니다.

confirmEmailVerificationCode에서 verifyEmail로의 변경은 더 간결하고 직관적입니다. 파라미터 타입도 새로운 모델 클래스에 맞춰 올바르게 업데이트되었습니다.

src/main/java/project/flipnote/auth/service/AuthService.java (2)

21-21: import 문이 새로운 모델 클래스에 맞춰 올바르게 업데이트되었습니다.

---

104-104: 테스트 코드 이미 메서드명 변경 반영됨—추가 업데이트 불필요

rg 검색 결과, 더 이상 confirmEmailVerificationCode를 참조하는 테스트가 존재하지 않습니다. 따라서 기존 리뷰에서 제안된 단위 테스트 수정은 불필요하며, 변경된 메서드명(verifyEmail)이 이미 테스트에 반영된 것으로 확인됩니다.

Likely an incorrect or invalid review comment.

src/main/java/project/flipnote/auth/controller/AuthController.java (5)

22-22: 새로운 모델 클래스로의 import 업데이트가 올바르게 적용되었습니다.

---

80-85: 이메일 인증 요청 엔드포인트 경로 개선이 잘 적용되었습니다.

기존 /email에서 /email-verification/request로의 변경은 더 명확하고 RESTful한 API 구조를 제공합니다. 엔드포인트의 목적이 더 명확하게 드러납니다.

---

87-94: 이메일 인증 확인 엔드포인트와 메서드 개선이 일관성 있게 적용되었습니다.

• 엔드포인트 경로: /email/confirm → /email-verification으로 더 직관적으로 변경
• 메서드명: confirmEmailVerificationCode → verifyEmail로 더 간결하게 변경
• 파라미터 타입: 새로운 EmailVerifyRequest 모델 사용

모든 변경사항이 일관성 있게 적용되어 API 설계가 개선되었습니다.

---

114-121: 비밀번호 재설정 요청 엔드포인트 경로 개선이 잘 적용되었습니다.

기존 /password-resets에서 /password-reset/request로의 변경은 더 명확한 의미를 전달하며, 단수형 사용과 /request 접미사 추가로 일관된 API 패턴을 만들었습니다.

---

123-130: 비밀번호 재설정 엔드포인트의 HTTP 메서드와 경로 변경이 적절합니다.

• 경로: /password-resets → /password-reset로 단수형으로 통일
• HTTP 메서드: PATCH → POST로 변경

새 비밀번호를 생성하는 작업의 특성상 POST 메서드가 더 적합하며, 엔드포인트 경로도 더 직관적으로 개선되었습니다.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/update-api-path

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.