ApiBehaviorOptions Classe

Definição

Namespace:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Pacote:

Microsoft.AspNetCore.App.Ref v8.0.0

Opções usadas para configurar o comportamento para tipos anotados com ApiControllerAttribute.

public class ApiBehaviorOptions : System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Mvc.Infrastructure.ICompatibilitySwitch>

type ApiBehaviorOptions = class
    interface seq<ICompatibilitySwitch>
    interface IEnumerable

Public Class ApiBehaviorOptions
Implements IEnumerable(Of ICompatibilitySwitch)

Herança

Object

ApiBehaviorOptions

Implementações

IEnumerable<ICompatibilitySwitch> IEnumerable

Construtores

ApiBehaviorOptions()

Cria uma nova instância de ApiBehaviorOptions.

Propriedades

ClientErrorMapping	Obtém um mapa de códigos de status HTTP para ClientErrorData. Os valores configurados são usados para transformar IClientErrorActionResult em uma ObjectResult instância em que o Value é ProblemDetails. O uso desse recurso pode ser desabilitado redefinindo SuppressMapClientErrors.
DisableImplicitFromServicesParameters	Obtém ou define um valor que determina se os parâmetros são inferidos para serem de serviços. Essa propriedade só é aplicável quando SuppressInferBindingSourcesForParameters é false.
InvalidModelStateResponseFactory	Delegado invocado em ações anotadas com ApiControllerAttribute para converter inválido ModelStateDictionary em um IActionResult
SuppressConsumesConstraintForFormFileParameters	Obtém ou define um valor que determina se uma multipart/form-data restrição de ação de consumo é adicionada aos parâmetros associados aos dados do formulário.
SuppressInferBindingSourcesForParameters	Obtém ou define um valor que determina se as fontes de associação de modelo são inferidas para parâmetros de ação em controladores anotados com ApiControllerAttribute é suprimido. Quando habilitadas, as seguintes fontes são inferidas: os parâmetros que aparecem como valores de rota são considerados associados do caminho (Path). Os parâmetros do tipo IFormFile e IFormFileCollection são considerados associados do formulário. Os parâmetros complexos (IsComplexType) e registrados no contêiner de DI (IServiceCollection) são considerados associados aos serviços Services, a menos que essa opção esteja explicitamente desabilitada DisableImplicitFromServicesParameters. Os parâmetros complexos (IsComplexType) são considerados associados do corpo (Body). Todos os outros parâmetros são considerados associados da consulta.
SuppressMapClientErrors	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.
SuppressModelStateInvalidFilter	Obtém ou define um valor que determina se o filtro que retorna um BadRequestObjectResult quando ModelState é inválido é suprimido. .

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Opções usadas para configurar o comportamento para tipos anotados com ApiControllerAttribute.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Opções usadas para configurar o comportamento para tipos anotados com ApiControllerAttribute.