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の修正 #73

Merged
merged 10 commits into from
May 3, 2024
Merged

Conversation

Z00One
Copy link
Member

@Z00One Z00One commented May 3, 2024

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

実装した機能や解決した課題、PRを開くきっかけや目的をReviewerが理解しやすいように書いてください。
バックログのリンク、ダイアグラム、Figmaなどの関連ドキュメントを添付するとより良いです。

  • クイズバンクAPIのエンドポイントをクラスと別にする

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

問題を解決しながら、主な変更点を書いてください。

  • クイズバンクを作成する時、クラスidだけでできるように修正

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

ない場合は「なし」と記載してください。

  • グローバル的に設定されていたクラスidが含まれるエンドポイントの削除
  • 権限を確認しなければならないAPIのエンドポイントだけにクラスidが含まれるように修正
  • クイズバンクモデルのクラスidフィールドを削除

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

開発過程で他の方の意見が気になったり、クロスチェックが必要だと感じたコードがあれば教えてください。

  • なし

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

テストが必要な項目やテストコードが追加されたら一緒に書いてください。

  • 変更されたクイズバンクコントローラーのテストコード

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

このPRが解決しようとしている問題に関連するIssueやドキュメント、Trelloがあればリンクを記載してください。Trelloの場合タイトルの形で添付してください。

🖥 作動する様子

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

📌 PRを行う際の注意点

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

Z00One added 10 commits May 3, 2024 10:33
- Removed c_id parameter from findMany method
- Updated where condition to only use u_id
- Removed class_user object from where condition
- Updated search method to remove c_id parameter from where condition
- Updated create method to remove c_id parameter
- Added getQuiz method to retrieve quiz content based on id and c_id
- Updated create method in QuizBankService to fetch quiz content from repository before creating
- Added error handling to check if quiz is not found before creating
- Improved code readability and error handling in create method
- Removed unnecessary parameter from create method
- Updated method signature to match new requirements
- Updated method logic to handle quiz content retrieval before creating
- Refactored error handling logic in quiz-bank controller methods
- Removed unnecessary parameter checks for c_id in search and getMany methods
Add ApiParam to the UseRoleGuards decorator in order to include 'c_id' parameter when required.
- Updated the controller routes to include 'api/nest/' prefix for better organization and clarity
- Removed redundant Role.ADMIN guards from controller methods
Updated the global prefix in the main.ts file to exclude 'api/nest/quiz-banks/:id' endpoint from the prefix
@Z00One Z00One added 🔨 Refactor 코드 리팩토링 📬 API 서버 API 통신 ⏰ P2 활발하게 고려해야 하는 이슈나 개선사항 🆗 safe CI workflow 동작 관련 labels May 3, 2024
prisma/schema.prisma Show resolved Hide resolved
src/main.ts Show resolved Hide resolved
@Z00One Z00One merged commit dc0a9cb into YJU-OKURA:main May 3, 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 통신 ⏰ P2 활발하게 고려해야 하는 이슈나 개선사항 🔨 Refactor 코드 리팩토링 🆗 safe CI workflow 동작 관련
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants