IApiDescriptionProvider Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a contract for specifying ApiDescription instances.
public interface class IApiDescriptionProviderpublic interface IApiDescriptionProvidertype IApiDescriptionProvider = interfacePublic Interface IApiDescriptionProvider- Derived
Remarks
On the first query for ActionDescriptor, MVC invokes all registered instances of IApiDescriptionProvider in the ascending sort order of Order.
Each provider has its OnProvidersExecuting(ApiDescriptionProviderContext) method called in sequence and given the same instance of ApiDescriptionProviderContext. Then each provider has its OnProvidersExecuted(ApiDescriptionProviderContext) method called in the reverse order. Each instance has an opportunity to add or modify Results.
As providers are called in a predefined sequence, each provider has a chance to observe and decorate the result of the providers that have already run.
Properties
| Order |
Gets the order value for determining the order of execution of providers. Providers execute in ascending numeric value of the Order property. |
Methods
| OnProvidersExecuted(ApiDescriptionProviderContext) |
Called after IApiDescriptionProvider implementations with higher Order values have been called. |
| OnProvidersExecuting(ApiDescriptionProviderContext) |
Creates or modifies ApiDescriptions. |