ApiBehaviorOptions Třída

Definice

Obor názvů:

Microsoft.AspNetCore.Mvc

Sestavení:

Microsoft.AspNetCore.Mvc.Core.dll

Balíček:

Microsoft.AspNetCore.App.Ref v8.0.0

Zdroj:

ApiBehaviorOptions.cs

Možnosti sloužící ke konfiguraci chování pro typy anotované pomocí 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)

Dědičnost

Object

ApiBehaviorOptions

Implementuje

IEnumerable<ICompatibilitySwitch> IEnumerable

Konstruktory

ApiBehaviorOptions()

Vytvoří novou instanci položky ApiBehaviorOptions.

Vlastnosti

ClientErrorMapping	Získá mapu stavových kódů HTTP na ClientErrorData. Nakonfigurované hodnoty se používají k transformaci IClientErrorActionResult na ObjectResult instanci, kde Value je ProblemDetails. Použití této funkce lze zakázat resetováním SuppressMapClientErrors.
DisableImplicitFromServicesParameters	Získá nebo nastaví hodnotu, která určuje, zda jsou parametry odvozeny ze služeb. Tato vlastnost je použitelná pouze v případě, že SuppressInferBindingSourcesForParameters je false.
InvalidModelStateResponseFactory	Delegát vyvolaný u akcí s poznámkami ApiControllerAttribute za účelem převodu neplatných ModelStateDictionary na IActionResult
SuppressConsumesConstraintForFormFileParameters	Získá nebo nastaví hodnotu, která určuje, zda multipart/form-data se používá omezení akce je přidán do parametrů, které jsou vázány z dat formuláře.
SuppressInferBindingSourcesForParameters	Získá nebo nastaví hodnotu, která určuje, zda jsou zdroje vazby modelu odvozeny pro parametry akce na kontroleru s poznámkami ApiControllerAttribute je potlačena. Pokud je tato možnost povolená, odvozují se následující zdroje: Parametry, které se zobrazují jako hodnoty trasy, se považují za svázané z cesty (Path). Parametry typu IFormFile a IFormFileCollection se předpokládají jako vázané z formuláře. Parametry, které jsou komplexní (IsComplexType) a jsou registrovány v kontejneru DI (IServiceCollection), se předpokládá, že jsou vázány ze služeb Services, pokud není tato možnost explicitně zakázána DisableImplicitFromServicesParameters. U parametrů, které jsou komplexní (IsComplexType), se předpokládá, že jsou vázány z těla (Body). Předpokládá se, že všechny ostatní parametry jsou vázány z dotazu.
SuppressMapClientErrors	Získá nebo nastaví hodnotu, která určuje, zda kontrolery s ApiControllerAttribute transformací určitých chyb klienta. Když false, filtr výsledků se přidá do akcí kontroleru rozhraní API, které transformují IClientErrorActionResult. V opačném případě je filtr potlačen. Ve výchozím nastavení ClientErrorMapping se používá k mapování IClientErrorActionResult na ProblemDetails instanci (vrácená jako hodnota pro ObjectResult). Pokud chcete přizpůsobit výstup filtru (například pro vrácení jiného typu chyby), zaregistrujte vlastní implementaci IClientErrorFactory v kolekci služeb.
SuppressModelStateInvalidFilter	Získá nebo nastaví hodnotu, která určuje, zda je potlačen filtr, který vrací BadRequestObjectResult , když ModelState je neplatný. .

Explicitní implementace rozhraní

IEnumerable.GetEnumerator()	Možnosti sloužící ke konfiguraci chování pro typy anotované pomocí ApiControllerAttribute.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Možnosti sloužící ke konfiguraci chování pro typy anotované pomocí ApiControllerAttribute.