ApiBehaviorOptions Classe

Definizione

Spazio dei nomi:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Pacchetto:

Microsoft.AspNetCore.App.Ref v8.0.0

Origine:

ApiBehaviorOptions.cs

Opzioni usate per configurare il comportamento per i tipi annotati con 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)

Ereditarietà

Object

ApiBehaviorOptions

Implementazioni

IEnumerable<ICompatibilitySwitch> IEnumerable

Costruttori

ApiBehaviorOptions()

Crea una nuova istanza di ApiBehaviorOptions.

Proprietà

ClientErrorMapping	Ottiene una mappa dei codici di stato HTTP a ClientErrorData. I valori configurati vengono usati per trasformare IClientErrorActionResult in un'istanza ObjectResult in cui è ValueProblemDetails. L'uso di questa funzionalità può essere disabilitato reimpostando SuppressMapClientErrors.
DisableImplicitFromServicesParameters	Ottiene o imposta un valore che determina se i parametri vengono dedotti dai servizi. Questa proprietà è applicabile solo quando SuppressInferBindingSourcesForParameters è false.
InvalidModelStateResponseFactory	Delegato richiamato sulle azioni annotate con ApiControllerAttribute per convertire non valido ModelStateDictionary in un IActionResult
SuppressConsumesConstraintForFormFileParameters	Ottiene o imposta un valore che determina se viene aggiunto un multipart/form-data vincolo di azione a parametri associati dai dati del modulo.
SuppressInferBindingSourcesForParameters	Ottiene o imposta un valore che determina se le origini di associazione del modello vengono posticipate per i parametri di azione nei controller annotati con ApiControllerAttribute viene eliminata. Se abilitata, le origini seguenti vengono dedotte: i parametri visualizzati come valori di route vengono considerati associati dal percorso (Path). Si presuppone che i parametri di tipo IFormFile siano IFormFileCollection associati dal modulo. I parametri complessi () e registrati nel contenitore DI (IsComplexTypeIServiceCollection) devono essere associati ai serviziServices, a meno che questa opzione non sia disabilitata DisableImplicitFromServicesParametersin modo esplicito. Si presuppone che i parametri complessi (IsComplexType) vengano associati dal corpo (Body). Si presuppone che tutti gli altri parametri vengano associati dalla query.
SuppressMapClientErrors	Ottiene o imposta un valore che determina se i controller con ApiControllerAttribute trasformazione di determinati errori client. Quando falseviene aggiunto un filtro dei risultati alle azioni del controller API che trasforma IClientErrorActionResult. In caso contrario, il filtro viene eliminato. Per impostazione predefinita, ClientErrorMapping viene usato per eseguire il mapping IClientErrorActionResult a un'istanza ProblemDetails (restituita come valore per ObjectResult). Per personalizzare l'output del filtro ,ad esempio per restituire un tipo di errore diverso, registrare un'implementazione personalizzata della raccolta di IClientErrorFactory servizi.
SuppressModelStateInvalidFilter	Ottiene o imposta un valore che determina se il filtro che restituisce un BadRequestObjectResult valore quando ModelState non è valido viene eliminato. .

Implementazioni dell'interfaccia esplicita

IEnumerable.GetEnumerator()	Opzioni usate per configurare il comportamento per i tipi annotati con ApiControllerAttribute.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Opzioni usate per configurare il comportamento per i tipi annotati con ApiControllerAttribute.