IApiDescriptionProvider 介面

定義

命名空間:

Microsoft.AspNetCore.Mvc.ApiExplorer

組件:

Microsoft.AspNetCore.Mvc.Abstractions.dll

套件:

Microsoft.AspNetCore.App.Ref v8.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

備註

在第一個查詢 ActionDescriptor 上，MVC 會以 的 Order 遞增排序次序叫用 的所有已註冊實例 IApiDescriptionProvider 。

每個提供者都有依序呼叫的方法 OnProvidersExecuting(ApiDescriptionProviderContext) ，並指定相同的 實例 ApiDescriptionProviderContext 。 然後，每個提供者都會以反向順序呼叫其 OnProvidersExecuted(ApiDescriptionProviderContext) 方法。 每個實例都有機會新增或修改 Results 。

當提供者在預先定義的序列中呼叫時，每個提供者都有機會觀察並裝飾已經執行的提供者結果。

屬性

Order

取得判斷提供者執行順序的順序值。 提供者會以屬性的 Order 遞增數值執行。

方法

OnProvidersExecuted(ApiDescriptionProviderContext)	在呼叫具有較高 Order 值的實作之後 IApiDescriptionProvider 呼叫。
OnProvidersExecuting(ApiDescriptionProviderContext)	建立或修改 ApiDescription s。