IApiDescriptionProvider Interfejs

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Mvc.ApiExplorer

Zestaw:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Pakiet:

Microsoft.AspNetCore.App.Ref v8.0.0

Źródło:

IApiDescriptionProvider.cs

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.