IApiDescriptionProvider Interface

Définition

Espace de noms:

Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Paquet:

Microsoft.AspNetCore.App.Ref v8.0.0

Définit un contrat pour spécifier des ApiDescription instances.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Dérivé

Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Remarques

Sur la première requête pour ActionDescriptor, MVC appelle toutes les instances inscrites de IApiDescriptionProvider dans l’ordre de tri croissant de Order.

Chaque fournisseur a sa OnProvidersExecuting(ApiDescriptionProviderContext) méthode appelée dans l’ordre et a donné la même instance de ApiDescriptionProviderContext. Ensuite, chaque fournisseur a sa OnProvidersExecuted(ApiDescriptionProviderContext) méthode appelée dans l’ordre inverse. Chaque instance a la possibilité d’ajouter ou de modifier Results.

Comme les fournisseurs sont appelés dans une séquence prédéfinie, chaque fournisseur a la possibilité d’observer et de décorer le résultat des fournisseurs qui ont déjà exécuté.

Propriétés

Order

Obtient la valeur de l’ordre pour déterminer l’ordre d’exécution des fournisseurs. Les fournisseurs s’exécutent en valeur numérique ascendante de la Order propriété.

Méthodes

OnProvidersExecuted(ApiDescriptionProviderContext)	Appelé après IApiDescriptionProvider l’appel des implémentations avec des valeurs supérieures Order .
OnProvidersExecuting(ApiDescriptionProviderContext)	Crée ou modifie ApiDescriptiondes s.