Microsoft.AspNetCore.Mvc.ApiExplorer 名前空間

コントローラーとアクションの一覧とその URL などのメタデータを検出できるようにする型を提供します。 これらの型は、OpenAPI を使用して API をドキュメント化する場合に役立ちます。

クラス

ApiConventionNameMatchAttribute	API 規約メソッドまたはパラメーターの一致動作を名前で決定します。 ApiConventionNameMatchBehavior サポートされているオプションの場合は 。 .
ApiConventionResult	API 規則を使用してアクション メソッドに関連付けられたメタデータ。
ApiConventionTypeMatchAttribute	API 規則パラメーターの一致動作を型別に決定します。 ApiConventionTypeMatchBehavior サポートされているオプションの場合は 。 .
ApiDescription	このアプリケーションによって公開される API を表します。
ApiDescriptionExtensions	ApiDescription の拡張メソッド。
ApiDescriptionGroup	関連する API のグループを表します。
ApiDescriptionGroupCollection	のキャッシュされたコレクション ApiDescriptionGroup。
ApiDescriptionGroupCollectionProvider	のコレクション ApiDescriptionGroupへのアクセスを提供します。
ApiDescriptionProviderContext	プロバイダーの ApiDescription コンテキスト オブジェクト。
ApiParameterDescription	API への入力のメタデータの説明。
ApiParameterRouteInfo	のルーティング情報 ApiParameterDescriptionのメタデータの説明。
ApiRequestFormat	要求の本文に使用できる形式。
ApiResponseFormat	に使用 ApiResponseTypeできる形式。
ApiResponseType	によって ApiResponseFormats書式設定された応答本文の可能な型。
DefaultApiDescriptionProvider	でControllerActionDescriptor表されるアクションの のApiDescriptionプロバイダーを実装します。

インターフェイス

IApiDefaultResponseMetadataProvider	他 IApiResponseMetadataProvider のインスタンスでカバーされていないすべての HTTP 状態コードの戻り値の型を提供します。
IApiDescriptionGroupCollectionProvider	のコレクション ApiDescriptionGroupへのアクセスを提供します。
IApiDescriptionGroupNameProvider	のグループ名メタデータを ApiDescription表します。
IApiDescriptionProvider	インスタンスを指定するためのコントラクトを ApiDescription 定義します。
IApiDescriptionVisibilityProvider	の可視性メタデータを ApiDescription表します。
IApiRequestFormatMetadataProvider	要求形式に関するメタデータ情報を に提供します IApiDescriptionProvider。
IApiRequestMetadataProvider	アクションで使用できるコンテンツ タイプのセットを提供します。
IApiResponseMetadataProvider	戻り値の種類、状態コード、およびアクションの正常な実行によって返される可能性のあるコンテンツ タイプのセットを提供します。
IApiResponseTypeMetadataProvider	応答形式に関するメタデータ情報を に提供します IApiDescriptionProvider。

列挙型

ApiConventionNameMatchBehavior	規則パラメーターまたはメソッドの名前を照合するための動作。
ApiConventionTypeMatchBehavior	規約パラメーターの型を照合するための動作。

注釈

Swagger (OpenAPI) の概要については、Swagger/OpenAPI を使用して Web API ドキュメントを ASP.NET Coreします。