Microsoft.AspNetCore.Mvc.ApiExplorer 名前空間

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

クラス

名前	説明
ApiConventionNameMatchAttribute	API 規則のメソッドまたはパラメーターの一致動作を名前で決定します。 ApiConventionNameMatchBehavior サポートされているオプションの場合は 〗。 <seealso cref="T:Microsoft。AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>.
ApiConventionResult	API 規則を使用してアクション メソッドに関連付けられたメタデータ。
ApiConventionTypeMatchAttribute	API 規則パラメーターの一致動作を型別に決定します。 ApiConventionTypeMatchBehavior サポートされているオプションの場合は 〗。 <seealso cref="T:Microsoft。AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>.
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) の概要についてはASP.NET Core Swagger/OpenAPI を使用した Web API ドキュメントを参照してください。