IApiDescriptionProvider Интерфейс

Определение

Пространство имен:

Microsoft.AspNetCore.Mvc.ApiExplorer

Сборка:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Пакет:

Microsoft.AspNetCore.App.Ref v9.0.0

Определяет контракт для указания ApiDescription экземпляров.

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

Производный

Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

Комментарии

В первом запросе для ActionDescriptorMVC вызывает все зарегистрированные экземпляры IApiDescriptionProvider в порядке Orderсортировки по возрастанию .

Каждый поставщик имеет свой OnProvidersExecuting(ApiDescriptionProviderContext) метод, вызываемый последовательно и заданный один и тот же экземпляр ApiDescriptionProviderContext. Затем у каждого поставщика есть свой OnProvidersExecuted(ApiDescriptionProviderContext) метод, вызываемый в обратном порядке. Каждый экземпляр имеет возможность добавить или изменить Results.

Так как поставщики вызываются в предопределенной последовательности, каждый поставщик имеет возможность наблюдать и декорировать результат уже запущенных поставщиков.

Свойства

Order

Возвращает значение порядка для определения порядка выполнения поставщиков. Поставщики выполняются в возрастающем числовом значении Order свойства .

Методы

OnProvidersExecuted(ApiDescriptionProviderContext)	Вызывается после IApiDescriptionProvider вызова реализаций с более высокими Order значениями.
OnProvidersExecuting(ApiDescriptionProviderContext)	Создает или изменяет ApiDescriptions.