ApiBehaviorOptions.SuppressMapClientErrors Propriété

Définition

Espace de noms:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Paquet:

Microsoft.AspNetCore.App.Ref v8.0.0

Obtient ou définit une valeur qui détermine si les contrôleurs avec ApiControllerAttribute certaines erreurs clientes de transformation.

Quand false, un filtre de résultat est ajouté aux actions du contrôleur d’API qui transforme IClientErrorActionResult. Sinon, le filtre est supprimé.

Par défaut, ClientErrorMapping est utilisé pour mapper IClientErrorActionResult à un ProblemDetails instance (retourné en tant que valeur pour ObjectResult).

Pour personnaliser la sortie du filtre (par exemple, pour retourner un autre type d’erreur), inscrivez une implémentation personnalisée de dans la collection de IClientErrorFactory services.

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

Valeur de propriété

Boolean

La valeur par défaut est false.

Remarques

Cette propriété est associée à un commutateur de compatibilité et peut fournir un comportement différent en fonction de la version de compatibilité configurée pour l’application. Consultez CompatibilityVersion pour obtenir des conseils et des exemples de définition de la version de compatibilité de l’application.

La configuration de la valeur souhaitée du commutateur de compatibilité en appelant le setter de cette propriété est prioritaire sur la valeur impliquée par le paramètre de CompatibilityVersionl’application.

Si la version de compatibilité de l’application est définie sur ou est inférieure, Version_2_1 ce paramètre aura la valeur false , sauf s’il est configuré explicitement.

Si la version de compatibilité de l’application est définie sur Version_2_2 ou une version supérieure, ce paramètre aura la valeur true , sauf s’il est configuré explicitement.