IApiDescriptionProvider Rozhraní

Definice

Obor názvů:

Microsoft.AspNetCore.Mvc.ApiExplorer

Sestavení:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Balíček:

Microsoft.AspNetCore.App.Ref v9.0.0

Definuje kontrakt pro určení ApiDescription instancí.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Odvozené

Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Poznámky

U prvního dotazu na vyvolá ActionDescriptorMVC všechny registrované instance objektu IApiDescriptionProvider ve vzestupném pořadí řazení .Order

Každý zprostředkovatel má svou OnProvidersExecuting(ApiDescriptionProviderContext) metodu v pořadí volanou a přiřazenou stejnou instanci .ApiDescriptionProviderContext Každý zprostředkovatel pak má svou OnProvidersExecuted(ApiDescriptionProviderContext) metodu s názvem v obráceném pořadí. Každá instance má možnost přidat nebo upravit Results.

Vzhledem k tomu, že se zprostředkovatelé volají v předdefinovaném pořadí, má každý zprostředkovatel možnost sledovat a zdobit výsledek zprostředkovatelů, kteří již spustili.

Vlastnosti

Order

Získá hodnotu objednávky pro určení pořadí provádění zprostředkovatelů. Zprostředkovatelé se spouští ve vzestupné číselné hodnotě Order vlastnosti .

Metody

OnProvidersExecuted(ApiDescriptionProviderContext)	Volána po IApiDescriptionProvider zavolání implementací s vyššími Order hodnotami.
OnProvidersExecuting(ApiDescriptionProviderContext)	Vytvoří nebo upraví ApiDescriptions.