ApiBehaviorOptions Clase

Definición

Espacio de nombres:

Microsoft.AspNetCore.Mvc

Ensamblado:

Microsoft.AspNetCore.Mvc.Core.dll

Paquete:

Microsoft.AspNetCore.App.Ref v8.0.0

Opciones usadas para configurar el comportamiento de los tipos anotados con 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)

Herencia

Object

ApiBehaviorOptions

Implementaciones

IEnumerable<ICompatibilitySwitch> IEnumerable

Constructores

ApiBehaviorOptions()

Crea una nueva instancia de ApiBehaviorOptions.

Propiedades

ClientErrorMapping	Obtiene una asignación de códigos de estado HTTP a ClientErrorData. Los valores configurados se usan para transformar IClientErrorActionResult en una ObjectResult instancia donde Value es ProblemDetails. El uso de esta característica se puede deshabilitar restableciendo SuppressMapClientErrors.
DisableImplicitFromServicesParameters	Obtiene o establece un valor que determina si se deducen los parámetros de los servicios. Esta propiedad solo es aplicable cuando SuppressInferBindingSourcesForParameters es false.
InvalidModelStateResponseFactory	Delegado invocado en acciones anotadas con ApiControllerAttribute para convertir no válidas ModelStateDictionary en un IActionResult
SuppressConsumesConstraintForFormFileParameters	Obtiene o establece un valor que determina si se agrega una multipart/form-data restricción de acción de consumo a los parámetros enlazados desde los datos del formulario.
SuppressInferBindingSourcesForParameters	Obtiene o establece un valor que determina si los orígenes de enlace de modelos se deducen para los parámetros de acción de los controladores anotados con ApiControllerAttribute se suprime. Cuando se habilita, se deducen los siguientes orígenes: se supone que los parámetros que aparecen como valores de ruta se enlazan desde la ruta de acceso (Path). Se supone que los parámetros de tipo IFormFile y IFormFileCollection se enlazan desde el formulario. Se supone que los parámetros que son complejos (IsComplexType) y se registran en el contenedor de inserción de dependencias (IServiceCollection) se enlazan desde los servicios Services, a menos que esta opción esté deshabilitada DisableImplicitFromServicesParametersexplícitamente. Se supone que los parámetros que son complejos (IsComplexType) se enlazan desde el cuerpo (Body). Se supone que todos los demás parámetros se enlazan desde la consulta.
SuppressMapClientErrors	Obtiene o establece un valor que determina si los controladores con ApiControllerAttribute transformación de determinados errores de cliente. Cuando false, se agrega un filtro de resultado a las acciones del controlador de API que transforman IClientErrorActionResult. De lo contrario, se suprime el filtro. De forma predeterminada, ClientErrorMapping se usa para asignar IClientErrorActionResult a una ProblemDetails instancia (devuelta como el valor de ObjectResult). Para personalizar la salida del filtro (por ejemplo, para devolver un tipo de error diferente), registre una implementación personalizada de IClientErrorFactory en la colección de servicios.
SuppressModelStateInvalidFilter	Obtiene o establece un valor que determina si se suprime el filtro que devuelve un BadRequestObjectResult cuando ModelState no es válido. .

Implementaciones de interfaz explícitas

IEnumerable.GetEnumerator()	Opciones usadas para configurar el comportamiento de los tipos anotados con ApiControllerAttribute.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Opciones usadas para configurar el comportamiento de los tipos anotados con ApiControllerAttribute.