ApiBehaviorOptions Classe

Définition

Espace de noms:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Paquet:

Microsoft.AspNetCore.App.Ref v8.0.0

Options utilisées pour configurer le comportement des types annotés avec 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)

Héritage

Object

ApiBehaviorOptions

Implémente

IEnumerable<ICompatibilitySwitch> IEnumerable

Constructeurs

ApiBehaviorOptions()

Crée une instance de ApiBehaviorOptions.

Propriétés

ClientErrorMapping	Obtient une carte des codes de status HTTP à ClientErrorData. Les valeurs configurées sont utilisées pour se transformer IClientErrorActionResult en instance ObjectResult où est ValueProblemDetails. L’utilisation de cette fonctionnalité peut être désactivée en réinitialisant SuppressMapClientErrors.
DisableImplicitFromServicesParameters	Obtient ou définit une valeur qui détermine si les paramètres sont déduits comme provenant des services. Cette propriété s’applique uniquement lorsque SuppressInferBindingSourcesForParameters est false.
InvalidModelStateResponseFactory	Délégué appelé sur les actions annotées avec ApiControllerAttribute pour convertir non valide ModelStateDictionary en un IActionResult
SuppressConsumesConstraintForFormFileParameters	Obtient ou définit une valeur qui détermine si une contrainte d’action multipart/form-data consomme est ajoutée aux paramètres liés à partir des données de formulaire.
SuppressInferBindingSourcesForParameters	Obtient ou définit une valeur qui détermine si les sources de liaison de modèle sont déduites pour les paramètres d’action sur les contrôleurs annotés avec ApiControllerAttribute est supprimée. Lorsque cette option est activée, les sources suivantes sont déduites : les paramètres qui apparaissent en tant que valeurs de routage sont supposés être liés à partir du chemin d’accès (Path). Les paramètres de type IFormFile et IFormFileCollection sont supposés être liés à partir du formulaire. Les paramètres complexes (IsComplexType) et inscrits dans le conteneur DI (IServiceCollection) sont supposés être liés à partir des services Services, sauf si cette option est explicitement désactivée DisableImplicitFromServicesParameters. Les paramètres complexes (IsComplexType) sont supposés être liés à partir du corps (Body). Tous les autres paramètres sont supposés être liés à partir de la requête.
SuppressMapClientErrors	Obtient ou définit une valeur qui détermine si les contrôleurs avec ApiControllerAttribute transformation de certaines erreurs clientes. Quand , falseun filtre de résultat est ajouté aux actions du contrôleur d’API qui transforme IClientErrorActionResult. Sinon, le filtre est supprimé. Par défaut, ClientErrorMapping est utilisé pour mapper IClientErrorActionResult à un ProblemDetails instance (retourné comme valeur pour ObjectResult). Pour personnaliser la sortie du filtre (par exemple, pour retourner un autre type d’erreur), inscrivez une implémentation personnalisée de dans la collection de IClientErrorFactory services.
SuppressModelStateInvalidFilter	Obtient ou définit une valeur qui détermine si le filtre qui retourne un BadRequestObjectResult quand ModelState n’est pas valide est supprimé. .

Implémentations d’interfaces explicites

IEnumerable.GetEnumerator()	Options utilisées pour configurer le comportement des types annotés avec ApiControllerAttribute.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Options utilisées pour configurer le comportement des types annotés avec ApiControllerAttribute.