ApiBehaviorOptions Classe

Référence

Définition

Espace de noms:: Microsoft.AspNetCore.Mvc

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

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

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

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

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

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

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

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

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

Paquet:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: ApiBehaviorOptions.cs

Source:: ApiBehaviorOptions.cs

Source:: ApiBehaviorOptions.cs

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Options utilisées pour configurer le comportement des types annotés avec ApiControllerAttribute.

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)

Héritage: Object
ApiBehaviorOptions

Implémente: IEnumerable<ICompatibilitySwitch> IEnumerable

Constructeurs

ApiBehaviorOptions()

Crée une instance de ApiBehaviorOptions.

Propriétés

AllowInferringBindingSourceForCollectionTypesAsFromQuery	Obtient ou définit une valeur qui détermine si BindingSource pour les types de collection (IsCollectionType). Quand , `true`la source de liaison pour les types de collection est déduite en tant que Query. Sinon est Body déduit.
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 Value ProblemDetails. 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 , `false`un 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é. .
SuppressUseValidationProblemDetailsForInvalidModelStateResponses	Obtient ou définit une valeur qui détermine si les contrôleurs annotés avec ApiControllerAttribute répondre à l’aide de ValidationProblemDetails dans InvalidModelStateResponseFactory. Quand `true`, SuppressModelStateInvalidFilter retourne les erreurs dans en ModelStateDictionary tant que ValidationProblemDetails. Sinon, SuppressModelStateInvalidFilter retourne les erreurs au format déterminé par SerializableError.

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.

S’applique à

Partager via