ApiBehaviorOptions Klasse

Referenz

Definition

Namespace:: Microsoft.AspNetCore.Mvc

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Paket:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Paket:: Microsoft.AspNetCore.Mvc.Core v2.2.0

Paket:: Microsoft.AspNetCore.App.Ref v3.0.1

Paket:: Microsoft.AspNetCore.App.Ref v3.1.10

Paket:: Microsoft.AspNetCore.App.Ref v5.0.0

Paket:: Microsoft.AspNetCore.App.Ref v6.0.6

Paket:: Microsoft.AspNetCore.App.Ref v7.0.5

Paket:: Microsoft.AspNetCore.App.Ref v8.0.0

Paket:: Microsoft.AspNetCore.App.Ref v9.0.0

Quelle:: ApiBehaviorOptions.cs

Quelle:: ApiBehaviorOptions.cs

Quelle:: ApiBehaviorOptions.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Optionen zum Konfigurieren des Verhaltens für Typen, die mit ApiControllerAttributekommentiert werden.

public ref class ApiBehaviorOptions

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

public class ApiBehaviorOptions

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

type ApiBehaviorOptions = class

type ApiBehaviorOptions = class
    interface seq<ICompatibilitySwitch>
    interface IEnumerable

Public Class ApiBehaviorOptions

Public Class ApiBehaviorOptions
Implements IEnumerable(Of ICompatibilitySwitch)

Vererbung: Object
ApiBehaviorOptions

Implementiert: IEnumerable<ICompatibilitySwitch> IEnumerable

Konstruktoren

ApiBehaviorOptions()

Erstellt eine neue Instanz von ApiBehaviorOptions.

Eigenschaften

AllowInferringBindingSourceForCollectionTypesAsFromQuery	Ruft einen Wert ab, der bestimmt, ob BindingSource für Auflistungstypen (IsCollectionType) festgelegt wird, oder legt diesen fest. Bei `true`wird die Bindungsquelle für Auflistungstypen als Queryabgeleitet. Andernfalls Body wird abgeleitet.
ClientErrorMapping	Ruft eine Zuordnung von HTTP-status-Codes zu abClientErrorData. Konfigurierte Werte werden verwendet, um in eine instance zu transformierenIClientErrorActionResult, bei der ist Value ProblemDetails.ObjectResult Die Verwendung dieses Features kann deaktiviert werden, indem zurückgesetzt SuppressMapClientErrorswird.
DisableImplicitFromServicesParameters	Ruft einen Wert ab, der bestimmt, ob Parameter von Diensten abgeleitet werden, oder legt diesen fest. Diese Eigenschaft gilt nur, wenn SuppressInferBindingSourcesForParameters ist `false`.
InvalidModelStateResponseFactory	Delegat, der für Aktionen aufgerufen wird, die mit ApiControllerAttribute kommentiert werden, um ungültig ModelStateDictionary in eine zu konvertieren IActionResult
SuppressConsumesConstraintForFormFileParameters	Ruft einen Wert ab, der bestimmt, ob eine `multipart/form-data` Nutzungseinschränkung zu Parametern hinzugefügt wird, die aus Formulardaten gebunden sind, oder legt diesen fest.
SuppressInferBindingSourcesForParameters	Ruft einen Wert ab, der bestimmt, ob Modellbindungsquellen für Aktionsparameter auf Controllern mit Anmerkungen ApiControllerAttribute unterdrückt werden, oder legt diesen fest. Wenn diese Option aktiviert ist, werden die folgenden Quellen abgeleitet: Parameter, die als Routenwerte angezeigt werden, werden davon ausgegangen, dass sie vom Pfad (Path) gebunden sind. Es wird davon ausgegangen, dass Parameter vom Typ IFormFile und IFormFileCollection vom Formular gebunden sind. Es wird davon ausgegangen, dass Parameter, die komplex (IsComplexType) sind und im DI-Container (IServiceCollection) registriert sind, von den Diensten Servicesgebunden sind, es sei denn, diese Option ist explizit deaktiviert DisableImplicitFromServicesParameters. Bei komplexen Parametern (IsComplexType) wird davon ausgegangen, dass sie vom TextBody () gebunden sind. Es wird davon ausgegangen, dass alle anderen Parameter von der Abfrage gebunden sind.
SuppressMapClientErrors	Ruft einen Wert ab, der bestimmt, ob Controller bestimmte ApiControllerAttribute Clientfehler transformieren, oder legt diesen fest. Wenn `false`, wird zu API-Controlleraktionen ein Ergebnisfilter hinzugefügt, der transformiert IClientErrorActionResult. Andernfalls wird der Filter unterdrückt. Wird standardmäßig verwendet, ClientErrorMapping um einem ProblemDetails instance zuzuordnen IClientErrorActionResult (wird als Wert für ObjectResultzurückgegeben). Um die Ausgabe des Filters anzupassen (z. B. um einen anderen Fehlertyp zurückzugeben), registrieren Sie eine benutzerdefinierte Implementierung von IClientErrorFactory in der Dienstsammlung.
SuppressModelStateInvalidFilter	Ruft einen Wert ab, der bestimmt, ob der Filter, der zurückgibt, BadRequestObjectResult wenn ModelState ungültig ist, unterdrückt wird, oder legt diesen fest. .
SuppressUseValidationProblemDetailsForInvalidModelStateResponses	Ruft einen Wert ab, der bestimmt, ob Controller mit ApiControllerAttribute Anmerkungen in antworten ValidationProblemDetails InvalidModelStateResponseFactory, oder legt diesen fest. Wenn `true`, SuppressModelStateInvalidFilter gibt Fehler in ModelStateDictionary als zurück ValidationProblemDetails. SuppressModelStateInvalidFilter Andernfalls werden die Fehler im von SerializableErrorfestgelegten Format zurückgegeben.

Explizite Schnittstellenimplementierungen

IEnumerable.GetEnumerator()	Optionen zum Konfigurieren des Verhaltens für Typen, die mit ApiControllerAttributekommentiert werden.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Optionen zum Konfigurieren des Verhaltens für Typen, die mit ApiControllerAttributekommentiert werden.

Gilt für:

Freigeben über