ApiBehaviorOptions.SuppressMapClientErrors プロパティ

定義

名前空間:

Microsoft.AspNetCore.Mvc

アセンブリ:

Microsoft.AspNetCore.Mvc.Core.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

コントローラーが特定のクライアント エラーを変換するかどうかを決定する値を ApiControllerAttribute 取得または設定します。

の場合 false、 を変換 IClientErrorActionResultする API コントローラー アクションに結果フィルターが追加されます。 それ以外の場合、フィルターは抑制されます。

既定では、 ClientErrorMapping は インスタンスにProblemDetailsマップIClientErrorActionResultするために使用されます (の値ObjectResultとして返されます)。

フィルターの出力をカスタマイズするには (たとえば、別のエラーの種類を返す場合)、 のカスタム実装 IClientErrorFactory をサービス コレクションに登録します。

public:
 property bool SuppressMapClientErrors { bool get(); void set(bool value); };

public bool SuppressMapClientErrors { get; set; }

member this.SuppressMapClientErrors : bool with get, set

Public Property SuppressMapClientErrors As Boolean

プロパティ値

Boolean

既定値は false です。

注釈

このプロパティは互換性スイッチに関連付けられているので、アプリケーションの構成済みの互換性バージョンに応じて異なる動作を提供できます。 アプリケーションの互換性バージョンの設定のガイダンスと例については、「」を参照してください CompatibilityVersion 。

このプロパティのセッターを呼び出して互換性スイッチの目的の値を構成すると、アプリケーション CompatibilityVersionの によって暗黙的に指定された値よりも優先されます。

アプリケーションの互換性バージョンが 以下に設定されている場合は、明示的に Version_2_1 構成しない限り、この設定の値 false が設定されます。

アプリケーションの互換性バージョンが 以上に設定されている場合、明示的に Version_2_2 構成しない限り、この設定の値 true が設定されます。