ApiBehaviorOptions.SuppressMapClientErrors 属性

定义

命名空间:

Microsoft.AspNetCore.Mvc

程序集:

Microsoft.AspNetCore.Mvc.Core.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

ApiBehaviorOptions.cs

获取或设置一个值，该值确定具有 ApiControllerAttribute 转换某些客户端错误的控制器。

当为 时 false，结果筛选器将添加到转换 的 API 控制器操作中 IClientErrorActionResult。 否则，将取消筛选器。

默认情况下， ClientErrorMapping 用于映射到IClientErrorActionResultProblemDetails实例 (作为) 的值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 。