IApiDescriptionProvider Rozhraní

Reference

Definice

Obor názvů:: Microsoft.AspNetCore.Mvc.ApiExplorer

Sestavení:: Microsoft.AspNetCore.Mvc.ApiExplorer.dll

Sestavení:: Microsoft.AspNetCore.Mvc.Abstractions.dll

Balíček:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0

Balíček:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0

Balíček:: Microsoft.AspNetCore.Mvc.Abstractions v2.0.0

Balíček:: Microsoft.AspNetCore.Mvc.Abstractions v2.1.0

Balíček:: Microsoft.AspNetCore.Mvc.Abstractions v2.2.0

Balíček:: Microsoft.AspNetCore.App.Ref v3.0.1

Balíček:: Microsoft.AspNetCore.App.Ref v3.1.10

Balíček:: Microsoft.AspNetCore.App.Ref v5.0.0

Balíček:: Microsoft.AspNetCore.App.Ref v6.0.6

Balíček:: Microsoft.AspNetCore.App.Ref v7.0.0-preview.5.22303.8

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

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

V prvním dotazu pro ActionDescriptorMVC vyvolá všechny registrované instance IApiDescriptionProvider ve vzestupném pořadí Orderřazení .

Každý poskytovatel má svou OnProvidersExecuting(ApiDescriptionProviderContext) metodu volanou v posloupnosti a vzhledem ke stejné instanci ApiDescriptionProviderContext. Každý zprostředkovatel pak má svou OnProvidersExecuted(ApiDescriptionProviderContext) metodu volanou v obráceném pořadí. Každá instance má příležitost přidat nebo upravit Results.

Vzhledem k tomu, že se poskytovatelé volají v předdefinované sekvenci, má každý poskytovatel možnost sledovat a vyzdobit výsledek zprostředkovatelů, kteří už jsou spuštěni.

Vlastnosti

Order

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

Metody

OnProvidersExecuted(ApiDescriptionProviderContext)	Volali jsme po IApiDescriptionProvider implementacích s vyššími Order hodnotami.
OnProvidersExecuting(ApiDescriptionProviderContext)	Vytvoří nebo upraví ApiDescriptions.

Platí pro