Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MIN-301] 出席 API のロギングとエラーハンドリングの改善、および Swagger ドキュメントの修正 #329

Merged

Conversation

yuminn-k
Copy link
Member

🔍 このPRで解決したい問題は何ですか?

  • 出席 API を利用する際、いくつかのエラーが発生していました。特に、GetAllAttendances エンドポイントにアクセスしたときの500エラーと、GetAttendanceByID メソッドで出席情報が見つからない場合の処理が問題となっていました。
  • また、Swagger ドキュメントの出席ステータスの説明に誤りがありました。
  • これらの問題を解決するために、ロギングの追加、エラーハンドリングの改善、およびドキュメントの修正を行いました。

✨ このPRで主に変わったことは何ですか?

  • GetAllAttendances メソッドおよび他の出席関連メソッドに詳細なロギングを追加し、デバッグと監視を強化しました。
  • GetAttendanceByID メソッドで出席情報が見つからない場合、404エラーを正しく処理するようにエラーハンドリングを改善しました。
  • Swagger ドキュメントの出席ステータス説明を修正し、'ATTENDANCE', 'TARDY', 'ABSENCE' の正しい値を使用するようにしました。

🔖 主な変更点以外に追加で変更された部分はありますか?

  • なし

🙏🏻 Reviewerに特に見ていただきたい部分はありますか?

  • ロギングの追加とエラーハンドリングの改善が適切に行われているかどうか、特に GetAttendanceByID メソッドでの404エラーの処理に注目していただきたいです。また、Swagger ドキュメントの修正が正確であるかも確認してください。

🩺 このPRでテストや検証が必要な部分はありますか?

  • GetAllAttendances メソッドおよび GetAttendanceByID メソッドの動作を確認するためのテストが必要です。特に、存在しない出席情報を要求した際に404エラーが正しく返されるかどうかを検証してください。

📚 関連するIssueやJira、ドキュメント

🖥 作動する様子

スクリーンショットや録画したビデオ、またはgifを追加して、Reviewerが変更点を理解するのに役立ててください。

📌 PRを行う際の注意点

  • Reviewerはコードレビュー時に良いコードの方向性を示しますが、コード修正を強制することはありません。
  • Reviewerは良いコードを見つけた場合、賞賛と励ましを惜しみません。
  • レビューは特別なケースでない限り、Reviewerに指定された時点から3日以内に行ってください。
  • コメント作成時にPrefixにP1、P2、P3を書いていただくと、Assigneeがより明確にコメントに対して対応することができます。
    • P1 : 必ず反映してください (Request Changes) - 問題が発生したり、脆弱性が発見されたケースなど。
    • P2 : 反映を積極的に検討していただければと思います (コメント)。
    • P3 : こんな方法もあるんじゃないかな~などの些細な意見です (Chore)。

yuminn-k added 2 commits June 16, 2024 18:49
…ints

- Added detailed logging in `GetAllAttendances` and other attendance-related methods to aid in debugging and monitoring.
- Enhanced error handling in `GetAttendanceByID` method to properly handle cases where attendance records are not found, returning a 404 error.

Related issue: YJU-OKURA#325
- Corrected the description for attendance status in Swagger docs to use the proper enum values 'ATTENDANCE', 'TARDY', 'ABSENCE' instead of 'Attendance', 'Tardy', 'Absence'.

Related issue: YJU-OKURA#325
@yuminn-k yuminn-k added ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) 🐞 BugFix Something isn't working 🔨 Refactor 코드 리팩토링 📬 API 서버 API 통신 📃 Docs 문서 작성 및 수정 (README.md 등) 🆗 safe CI workflow 동작 관련 labels Jun 16, 2024
docs/docs.go Show resolved Hide resolved
docs/swagger.json Show resolved Hide resolved
docs/swagger.yaml Show resolved Hide resolved
Copy link
Collaborator

@Regulus0811 Regulus0811 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

承認👍

@yuminn-k yuminn-k merged commit 1a93ad7 into YJU-OKURA:main Jun 16, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📬 API 서버 API 통신 🐞 BugFix Something isn't working 📃 Docs 문서 작성 및 수정 (README.md 등) ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) 🔨 Refactor 코드 리팩토링 🆗 safe CI workflow 동작 관련
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants