ApiBehaviorOptions 类

定义

命名空间:

Microsoft.AspNetCore.Mvc

程序集:

Microsoft.AspNetCore.Mvc.Core.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

用于配置使用 ApiControllerAttribute批注的类型的行为的选项。

public class ApiBehaviorOptions : System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Mvc.Infrastructure.ICompatibilitySwitch>

type ApiBehaviorOptions = class
    interface seq<ICompatibilitySwitch>
    interface IEnumerable

Public Class ApiBehaviorOptions
Implements IEnumerable(Of ICompatibilitySwitch)

继承

Object

ApiBehaviorOptions

实现

IEnumerable<ICompatibilitySwitch> IEnumerable

构造函数

ApiBehaviorOptions()

创建 ApiBehaviorOptions 的新实例。

属性

ClientErrorMapping	获取 HTTP 状态代码到 的 ClientErrorData映射。 配置的值用于转换为 IClientErrorActionResultObjectResult 为 ProblemDetails的Value实例。 可以通过重置 SuppressMapClientErrors来禁用此功能的使用。
DisableImplicitFromServicesParameters	获取或设置一个值，该值确定是否从服务推断参数。 此属性仅在 为 false时SuppressInferBindingSourcesForParameters适用。
InvalidModelStateResponseFactory	对使用 ApiControllerAttribute 进行批注的操作调用的委托，以将无效 ModelStateDictionary 转换为 IActionResult
SuppressConsumesConstraintForFormFileParameters	获取或设置一个值，该值确定是否 multipart/form-data 将 消耗操作约束添加到从表单数据绑定的参数中。
SuppressInferBindingSourcesForParameters	获取或设置一个值，该值确定是否对使用 ApiControllerAttribute 批注的控制器上的操作参数推断模型绑定源。 启用后，将推断以下源：显示为路由值的参数假定从路径绑定 (Path) 。 假定类型为 和 IFormFileCollection 的参数IFormFile从窗体绑定。 如果参数复杂 (IsComplexType) 并在 DI 容器 (IServiceCollection) 中注册，则假定从服务 Services绑定，除非显式禁用 DisableImplicitFromServicesParameters此选项。 假定复杂 (IsComplexType) 的参数从正文 (Body) 绑定。 假定所有其他参数都与查询绑定。
SuppressMapClientErrors	获取或设置一个值，该值确定具有 ApiControllerAttribute 转换某些客户端错误的控制器。 当为 时 false，结果筛选器将添加到转换 的 API 控制器操作中 IClientErrorActionResult。 否则，将取消筛选器。 默认情况下， ClientErrorMapping 用于映射到IClientErrorActionResultProblemDetails实例 (作为) 的值ObjectResult返回。 若要自定义筛选器 (的输出，例如返回不同的错误类型) ，请在服务集合中注册 的 IClientErrorFactory 自定义实现。
SuppressModelStateInvalidFilter	获取或设置一个值，该值确定是否禁止在 无效时ModelState返回 的BadRequestObjectResult筛选器。 .

显式接口实现

IEnumerable.GetEnumerator()	用于配置使用 ApiControllerAttribute批注的类型的行为的选项。
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	用于配置使用 ApiControllerAttribute批注的类型的行为的选项。