ApiBehaviorOptions.SuppressMapClientErrors Eigenschaft

Definition

Namespace:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Quelle:

ApiBehaviorOptions.cs

Ruft einen Wert ab, der bestimmt, ob Controller mit ApiControllerAttribute bestimmten Clientfehlern transformiert werden, oder legt diesen fest.

Wenn falsewird ein Ergebnisfilter zu API-Controlleraktionen hinzugefügt, die transformieren IClientErrorActionResult. Andernfalls wird der Filter unterdrückt.

Wird standardmäßig verwendet, ClientErrorMapping um einem ProblemDetails instance zuzuordnen IClientErrorActionResult (wird als Wert für ObjectResultzurückgegeben).

Um die Ausgabe des Filters anzupassen (z. B. um einen anderen Fehlertyp zurückzugeben), registrieren Sie eine benutzerdefinierte Implementierung von IClientErrorFactory in der Dienstsammlung.

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

Eigenschaftswert

Boolean

Standardwert: false.

Hinweise

Diese Eigenschaft ist einem Kompatibilitätsschalter zugeordnet und kann je nach konfigurierter Kompatibilitätsversion für die Anwendung ein anderes Verhalten bereitstellen. Anleitungen und Beispiele zum Festlegen der Kompatibilitätsversion der Anwendung finden Sie CompatibilityVersion unter.

Das Konfigurieren des gewünschten Werts des Kompatibilitätsschalters CompatibilityVersiondurch Aufrufen des Setters dieser Eigenschaft hat Vorrang vor dem Wert, der von der Anwendung impliziert wird.

Wenn die Kompatibilitätsversion der Anwendung auf Version_2_1 oder niedriger festgelegt ist, hat diese Einstellung den Wert false , sofern nicht explizit konfiguriert.

Wenn die Kompatibilitätsversion der Anwendung auf oder höher Version_2_2 festgelegt ist, hat diese Einstellung den Wert true , sofern nicht explizit konfiguriert.