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

出席管理APIのルート構造改善とSwagger文書の強化 #355

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

yuminn-k
Copy link
Member

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

  • 既存の出席管理APIのルート構造が一貫性に欠け、RESTful APIの原則に完全に準拠していない問題がありました
  • Swagger文書の記述が不十分で、API利用者にとって分かりにくい状態でした
  • エラーレスポンスの形式が統一されておらず、クライアント側での処理が煩雑になっていました

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

  • APIルートの構造をRESTful原則に基づいて統一(/api/gin/attendancesをベースとした一貫性のある構造)
  • 共通のレスポンス型(SuccessResponseErrorResponse)を導入し、レスポンス形式を標準化
  • Swagger文書に詳細な説明、レスポンスモデル、エラーケースを追加
  • エラーハンドリングの共通化と改善

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

  • コードのログ出力を強化し、デバッグ時の可読性を向上
  • テストケース追加の準備としてのインターフェース改善

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

  • 新しいAPIルート構造が実際のユースケースに適しているか
  • エラーレスポンスの形式が十分な情報を提供しているか
  • Swagger文書の記述が API利用者にとって分かりやすいものになっているか

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

  • 各エンドポイントの新しいルート構造での動作確認
  • エラーケースでの適切なレスポンス返却の確認
  • Swagger UIでの文書表示の確認
  • クライアントアプリケーションとの互換性テスト

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

🖥 作動する様子

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

📌 PRを行う際の注意点

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

- Standardize API route structure following REST principles
- Improve response types and error handling
- Add comprehensive Swagger documentation
- Unify response formats and status codes
- Create reusable error handling functions
- Improve code organization and readability

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 Nov 11, 2024
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 ea8985c into YJU-OKURA:main Nov 11, 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