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

Web APIのエラーレスポンスにエラー情報を詰めて返却できるようにする #1872

Open
tsuna-can-se opened this issue Oct 10, 2024 · 0 comments
Labels
target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプルに関係がある target: Dressca サンプルアプリケーションDresscaに関係がある

Comments

@tsuna-can-se
Copy link
Contributor

概要

業務エラーが発生した際、Web API側ではBusinessExceptionの派生クラスをスローすることになっている。
このとき、エラーの発生する原因となった情報は、例外メッセージに詰め込まれるのみで、独立した値として例外オブジェクトには保持していない。
Web API のエラーレスポンスは Problem Details の形に整理するが、その中にエラー発生の原因となった情報を詰め込めるようにしたい。

最終的には、クライアント側のメッセージ管理につながる。
Maia側で詳細に設計しているので、そちらと齟齬の内容な実装にしたい。

なお本 Issue では、バックエンドの実装のみをターゲットとする。
フロントエンドの実装は AlesInfiny Maia が先行する。
組合せてうまく動作するようにしなければならない。

対象は Dressca 本体と Azure AD B2C サンプル。

詳細 / 機能詳細(オプション)

業務例外の集約例外ハンドラーで実施する以外に、コントローラーのアクションメソッドからエラーレスポンスを返却するケースがある。
また返却するHTTPレスポンスも、400ではないものが存在する。
これらにおいても、アクションメソッド内で業務例外をハンドリングしてレスポンスに変換する際、エラーの発生する原因となった情報をProblem Detailsに詰め込みたい。

完了条件

  • 業務エラー発生時に、 Web API のレスポンスにエラーの発生する原因となった情報が詰め込まれていること
  • 業務例外の集約例外ハンドラーに加えて、アクションメソッド内でハンドリングする場合も、うまくこの要件を実現できる設計・実装の工夫があること
@tsuna-can-se tsuna-can-se added target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプルに関係がある target: Dressca サンプルアプリケーションDresscaに関係がある labels Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプルに関係がある target: Dressca サンプルアプリケーションDresscaに関係がある
Projects
None yet
Development

No branches or pull requests

1 participant