ApiBehaviorOptions.SuppressMapClientErrors Propriedade

Definição

Namespace:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Pacote:

Microsoft.AspNetCore.App.Ref v8.0.0

Origem:

ApiBehaviorOptions.cs

Obtém ou define um valor que determina se os controladores com ApiControllerAttribute transformam determinados erros de cliente.

Quando false, um filtro de resultado é adicionado às ações do controlador de API que transforma IClientErrorActionResult. Caso contrário, o filtro será suprimido.

Por padrão, ClientErrorMapping é usado para mapear IClientErrorActionResult para uma ProblemDetails instância (retornado como o valor para ObjectResult).

Para personalizar a saída do filtro (por exemplo, para retornar um tipo de erro diferente), registre uma implementação personalizada de IClientErrorFactory na coleção de serviços.

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 da propriedade

Boolean

O valor padrão é false.

Comentários

Essa propriedade está associada a uma opção de compatibilidade e pode fornecer um comportamento diferente dependendo da versão de compatibilidade configurada para o aplicativo. Consulte CompatibilityVersion para obter diretrizes e exemplos de como definir a versão de compatibilidade do aplicativo.

Configurar o valor desejado da opção de compatibilidade chamando o setter dessa propriedade terá precedência sobre o valor implícito pelo aplicativo CompatibilityVersion.

Se a versão de compatibilidade do aplicativo estiver definida Version_2_1 como ou menor, essa configuração terá o valor false , a menos que explicitamente configurado.

Se a versão de compatibilidade do aplicativo estiver definida Version_2_2 como ou superior, essa configuração terá o valor true , a menos que explicitamente configurado.