IApiDescriptionProvider Interfejs

Odwołanie

Definicja

Przestrzeń nazw:: Microsoft.AspNetCore.Mvc.ApiExplorer

Zestaw:: Microsoft.AspNetCore.Mvc.ApiExplorer.dll

Zestaw:: Microsoft.AspNetCore.Mvc.Abstractions.dll

Pakiet:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0

Pakiet:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0

Pakiet:: Microsoft.AspNetCore.Mvc.Abstractions v2.0.0

Pakiet:: Microsoft.AspNetCore.Mvc.Abstractions v2.1.0

Pakiet:: Microsoft.AspNetCore.Mvc.Abstractions v2.2.0

Pakiet:: Microsoft.AspNetCore.App.Ref v3.0.1

Pakiet:: Microsoft.AspNetCore.App.Ref v3.1.10

Pakiet:: Microsoft.AspNetCore.App.Ref v5.0.0

Pakiet:: Microsoft.AspNetCore.App.Ref v6.0.6

Pakiet:: Microsoft.AspNetCore.App.Ref v7.0.5

Pakiet:: Microsoft.AspNetCore.App.Ref v8.0.0

Pakiet:: Microsoft.AspNetCore.App.Ref v9.0.0

Źródło:: IApiDescriptionProvider.cs

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Definiuje kontrakt do określania ApiDescription wystąpień.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Pochodne: Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Uwagi

W pierwszym zapytaniu dla ActionDescriptorklasy MVC wywołuje wszystkie zarejestrowane wystąpienia IApiDescriptionProvider w kolejności sortowania rosnącego .Order

Każdy dostawca ma metodę OnProvidersExecuting(ApiDescriptionProviderContext) wywoływaną w sekwencji i nadaj jej to samo wystąpienie ApiDescriptionProviderContext. Następnie każdy dostawca ma metodę OnProvidersExecuted(ApiDescriptionProviderContext) wywoływaną w odwrotnej kolejności. Każde wystąpienie ma możliwość dodania lub zmodyfikowania Resultselementu .

Ponieważ dostawcy są wywoływani w wstępnie zdefiniowanej sekwencji, każdy dostawca ma szansę obserwować i dekorować wynik dostawców, którzy już działają.

Właściwości

Order

Pobiera wartość zamówienia do określania kolejności wykonywania dostawców. Dostawcy wykonują rosnącą wartość liczbową Order właściwości.

Metody

OnProvidersExecuted(ApiDescriptionProviderContext)	IApiDescriptionProvider Wywołano implementacje z wyższymi Order wartościami.
OnProvidersExecuting(ApiDescriptionProviderContext)	Tworzy lub modyfikuje ApiDescriptions.

Dotyczy

Udostępnij za pośrednictwem