ApiBehaviorOptions.SuppressMapClientErrors Właściwość

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Mvc

Zestaw:

Microsoft.AspNetCore.Mvc.Core.dll

Pakiet:

Microsoft.AspNetCore.App.Ref v8.0.0

Pobiera lub ustawia wartość, która określa, czy kontrolery z przekształcaniem ApiControllerAttribute niektórych błędów klienta.

Gdy falsefiltr wyników jest dodawany do akcji kontrolera interfejsu API, które przekształcają IClientErrorActionResultelement . W przeciwnym razie filtr zostanie pominięty.

Domyślnie ClientErrorMapping element jest używany do mapowania IClientErrorActionResult na ProblemDetails wystąpienie (zwracane jako wartość parametru ObjectResult).

Aby dostosować dane wyjściowe filtru (na przykład w celu zwrócenia innego typu błędu), zarejestruj niestandardową implementację IClientErrorFactory w kolekcji usług.

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

Wartość właściwości

Boolean

Wartość domyślna to false.

Uwagi

Ta właściwość jest skojarzona z przełącznikiem zgodności i może zapewnić inne zachowanie w zależności od skonfigurowanej wersji zgodności dla aplikacji. Zobacz CompatibilityVersion wskazówki i przykłady ustawiania wersji zgodności aplikacji.

Skonfigurowanie żądanej wartości przełącznika zgodności przez wywołanie metody ustawiającej tej właściwości będzie mieć pierwszeństwo przed wartością dorozumianą przez aplikację CompatibilityVersion.

Jeśli wersja zgodności aplikacji jest ustawiona na Version_2_1 lub niższa, to to ustawienie będzie miało wartość false , chyba że jawnie skonfigurowano.

Jeśli wersja zgodności aplikacji jest ustawiona na Version_2_2 lub nowszą, to ustawienie będzie miało wartość true , chyba że zostanie jawnie skonfigurowana.