ApiBehaviorOptions.SuppressMapClientErrors Proprietà

Definizione

Spazio dei nomi:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Pacchetto:

Microsoft.AspNetCore.App.Ref v8.0.0

Ottiene o imposta un valore che determina se i controller con ApiControllerAttribute trasformazione di determinati errori client.

Quando falseviene aggiunto un filtro dei risultati alle azioni del controller API che trasforma IClientErrorActionResult. In caso contrario, il filtro viene eliminato.

Per impostazione predefinita, ClientErrorMapping viene usato per eseguire il mapping IClientErrorActionResult a un'istanza ProblemDetails (restituita come valore per ObjectResult).

Per personalizzare l'output del filtro ,ad esempio per restituire un tipo di errore diverso, registrare un'implementazione personalizzata della raccolta di IClientErrorFactory servizi.

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

Valore della proprietà

Boolean

Il valore predefinito è false.

Commenti

Questa proprietà è associata a un commutatore di compatibilità e può fornire un comportamento diverso a seconda della versione di compatibilità configurata per l'applicazione. Per indicazioni ed esempi, vedere CompatibilityVersion l'impostazione della versione di compatibilità dell'applicazione.

La configurazione del valore desiderato del commutatore di compatibilità chiamando il setter della proprietà avrà la precedenza sul valore implicito dell'applicazione CompatibilityVersion.

Se la versione di compatibilità dell'applicazione è impostata su Version_2_1 o inferiore, questa impostazione avrà il valore false a meno che non sia configurato in modo esplicito.

Se la versione di compatibilità dell'applicazione è impostata su Version_2_2 o superiore, questa impostazione avrà il valore true a meno che non sia configurato in modo esplicito.