ApiBehaviorOptions.SuppressMapClientErrors 屬性

定義

命名空間:

Microsoft.AspNetCore.Mvc

組件:

Microsoft.AspNetCore.Mvc.Core.dll

套件:

Microsoft.AspNetCore.App.Ref v8.0.0

來源:

ApiBehaviorOptions.cs

取得或設定值，這個值會判斷是否有 ApiControllerAttribute 轉換特定用戶端錯誤的控制器。

當 為 時 false ，結果篩選會新增至轉換 的 IClientErrorActionResult API 控制器動作。 否則，會隱藏篩選。

根據預設， ClientErrorMapping 會用來對應 IClientErrorActionResult 至 ProblemDetails 傳回為) 值的 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 。

藉由呼叫此屬性的 setter，設定相容性參數所需的值，會優先于應用程式 CompatibilityVersion 所隱含的值。

如果應用程式的相容性版本設定為 Version_2_1 或更低版本，則除非明確設定此設定，否則此設定將會有 值 false 。

如果應用程式的相容性版本設定為 Version_2_2 或更新版本，則除非明確設定此設定，否則此設定將會有 值 true 。