IApiDescriptionProvider.Order Property

Definition

Namespace:

Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Gets the order value for determining the order of execution of providers. Providers execute in ascending numeric value of the Order property.

public:
 property int Order { int get(); };

public int Order { get; }

member this.Order : int

Public ReadOnly Property Order As Integer

Property Value

Int32

Remarks

Providers are executed in an ordering determined by an ascending sort of the Order property. A provider with a lower numeric value of Order will have its OnProvidersExecuting(ApiDescriptionProviderContext) called before that of a provider with a higher numeric value of Order. The OnProvidersExecuted(ApiDescriptionProviderContext) method is called in the reverse ordering after all calls to OnProvidersExecuting(ApiDescriptionProviderContext). A provider with a lower numeric value of Order will have its OnProvidersExecuted(ApiDescriptionProviderContext) method called after that of a provider with a higher numeric value of Order.

If two providers have the same numeric value of Order, then their relative execution order is undefined.