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では、 の登録されているすべてのインスタンスが IApiDescriptionProvider 、 の昇順 Orderで呼び出されます。

各プロバイダーには、 メソッドが OnProvidersExecuting(ApiDescriptionProviderContext) 順番に呼び出され、 の同じインスタンス ApiDescriptionProviderContextが指定されています。 その後、各プロバイダーは、その OnProvidersExecuted(ApiDescriptionProviderContext) メソッドを逆の順序で呼び出します。 各インスタンスには、 を追加または変更 Resultsする機会があります。

プロバイダーは定義済みのシーケンスで呼び出されるため、各プロバイダーには、既に実行されているプロバイダーの結果を観察して装飾する機会があります。

プロパティ

Order

プロバイダーの実行順序を決定するための順序値を取得します。 プロバイダーは、 プロパティの昇順の Order 数値で実行されます。

メソッド

OnProvidersExecuted(ApiDescriptionProviderContext)	より高いOrder値を持つ実装が呼び出された後IApiDescriptionProviderに呼び出されます。
OnProvidersExecuting(ApiDescriptionProviderContext)	を作成または変更します ApiDescription。