ApiDescriptionGroup クラス

定義

名前空間:

Microsoft.AspNetCore.Mvc.ApiExplorer

アセンブリ:

Microsoft.AspNetCore.Mvc.ApiExplorer.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v10.0.0

関連する API のグループを表します。

public ref class ApiDescriptionGroup

public class ApiDescriptionGroup

type ApiDescriptionGroup = class

Public Class ApiDescriptionGroup

継承

Object

ApiDescriptionGroup

注釈

エンドポイントは GroupNameによってグループ化されます。これは、最小限の API エンドポイントの WithGroupName 拡張メソッドまたはコントローラー アクションの [ApiExplorerSettings(GroupName = "...")] 属性を使用して設定できます。 明示的なグループ名のないエンドポイントは、 nullGroupNameを持つ単一のグループに配置されます。

MapGroup はエンドポイントのグループ名を設定しないことに注意してください。 ルート プレフィックスのみが適用されます。 ルート グループ内のすべてのエンドポイントにグループ名を割り当てるには、MapGroup 呼び出しで WithGroupName をチェーンします。

コンストラクター

名前	説明
ApiDescriptionGroup(String, IReadOnlyList<ApiDescription>)	新しい ApiDescriptionGroupを作成します。

プロパティ

名前	説明
GroupName	グループ名。
Items	このグループの ApiDescription 項目のコレクション。