ApiBehaviorOptions.SuppressMapClientErrors Propiedad

Definición

Espacio de nombres:

Microsoft.AspNetCore.Mvc

Ensamblado:

Microsoft.AspNetCore.Mvc.Core.dll

Paquete:

Microsoft.AspNetCore.App.Ref v8.0.0

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.

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

Valor de propiedad

Boolean

El valor predeterminado es false.

Comentarios

Esta propiedad está asociada a un modificador de compatibilidad y puede proporcionar un comportamiento diferente en función de la versión de compatibilidad configurada para la aplicación. Consulte CompatibilityVersion para obtener instrucciones y ejemplos de cómo establecer la versión de compatibilidad de la aplicación.

La configuración del valor deseado del modificador de compatibilidad mediante una llamada al establecedor de esta propiedad tendrá prioridad sobre el valor implícito por la aplicación CompatibilityVersion.

Si la versión de compatibilidad de la aplicación se establece Version_2_1 en o inferior, esta configuración tendrá el valor false a menos que se configure explícitamente.

Si la versión de compatibilidad de la aplicación se establece Version_2_2 en o superior, esta configuración tendrá el valor true a menos que se configure explícitamente.