IApiDescriptionProvider Schnittstelle

Definition

Namespace:

Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Quelle:

IApiDescriptionProvider.cs

Definiert einen Vertrag zum Angeben von ApiDescription Instanzen.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Abgeleitet

Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Hinweise

In der ersten Abfrage für ActionDescriptorruft MVC alle registrierten Instanzen von IApiDescriptionProvider in der aufsteigenden Sortierreihenfolge von auf Order.

Jeder Anbieter hat seine OnProvidersExecuting(ApiDescriptionProviderContext) Methode nacheinander aufgerufen und erhält die gleiche instance von ApiDescriptionProviderContext. Dann hat jeder Anbieter seine OnProvidersExecuted(ApiDescriptionProviderContext) Methode in umgekehrter Reihenfolge aufgerufen. Jeder instance hat die Möglichkeit, hinzuzufügen oder zu ändernResults.

Da Anbieter in einer vordefinierten Reihenfolge aufgerufen werden, hat jeder Anbieter die Möglichkeit, das Ergebnis der bereits ausgeführten Anbieter zu beobachten und zu ergänzen.

Eigenschaften

Order

Ruft den Auftragswert zum Bestimmen der Ausführungsreihenfolge von Anbietern ab. Anbieter werden im aufsteigenden numerischen Wert der Order Eigenschaft ausgeführt.

Methoden

OnProvidersExecuted(ApiDescriptionProviderContext)	Wird aufgerufen, nachdem IApiDescriptionProvider Implementierungen mit höheren Order Werten aufgerufen wurden.
OnProvidersExecuting(ApiDescriptionProviderContext)	Erstellt oder ändert ApiDescriptions.