ApiBehaviorOptions Klasa

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Mvc

Zestaw:

Microsoft.AspNetCore.Mvc.Core.dll

Pakiet:

Microsoft.AspNetCore.App.Ref v8.0.0

Źródło:

ApiBehaviorOptions.cs

Opcje używane do konfigurowania zachowania dla typów z adnotacjami za pomocą ApiControllerAttributepolecenia .

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)

Dziedziczenie

Object

ApiBehaviorOptions

Implementuje

IEnumerable<ICompatibilitySwitch> IEnumerable

Konstruktory

ApiBehaviorOptions()

Tworzy nowe wystąpienie klasy ApiBehaviorOptions.

Właściwości

ClientErrorMapping	Pobiera mapę kodów stanu HTTP na ClientErrorData. Skonfigurowane wartości są używane do przekształcania IClientErrorActionResultObjectResult w wystąpienie, w którym wartość Value to ProblemDetails. Korzystanie z tej funkcji można wyłączyć, resetując SuppressMapClientErrorselement .
DisableImplicitFromServicesParameters	Pobiera lub ustawia wartość, która określa, czy parametry są wnioskowane na podstawie usług. Ta właściwość ma zastosowanie tylko wtedy, gdy SuppressInferBindingSourcesForParameters ma falsewartość .
InvalidModelStateResponseFactory	Delegowanie wywoływane dla akcji z adnotacjami ApiControllerAttribute w celu przekonwertowania nieprawidłowego ModelStateDictionary na IActionResult
SuppressConsumesConstraintForFormFileParameters	Pobiera lub ustawia wartość, która określa, czy multipart/form-data ograniczenie akcji jest dodawane do parametrów powiązanych z danymi formularza.
SuppressInferBindingSourcesForParameters	Pobiera lub ustawia wartość, która określa, czy źródła powiązań modelu są wnioskowane dla parametrów akcji na kontrolerach z adnotacjami ApiControllerAttribute jest pomijane. Po włączeniu następujące źródła są wnioskowane: Parametry, które są wyświetlane jako wartości trasy, przyjmuje się, że mają być powiązane ze ścieżką (Path). Parametry typu IFormFile i IFormFileCollection zakłada się, że mają być powiązane z formularzem. Przyjmuje się, że parametry złożone (IsComplexType) i zarejestrowane w kontenerze DI (IServiceCollection) są powiązane z usługami Services, chyba że ta opcja jest jawnie wyłączona DisableImplicitFromServicesParameters. Przyjmuje się, że parametry złożone (IsComplexType) są powiązane z treścią (Body). Przyjmuje się, że wszystkie inne parametry są powiązane z zapytaniem.
SuppressMapClientErrors	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.
SuppressModelStateInvalidFilter	Pobiera lub ustawia wartość, która określa, czy filtr, który zwraca BadRequestObjectResult wartość, gdy ModelState jest nieprawidłowy, jest pomijany. .

Jawne implementacje interfejsu

IEnumerable.GetEnumerator()	Opcje używane do konfigurowania zachowania dla typów z adnotacjami za pomocą ApiControllerAttributepolecenia .
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Opcje używane do konfigurowania zachowania dla typów z adnotacjami za pomocą ApiControllerAttributepolecenia .