ApiDescription クラス

定義

名前空間:

Microsoft.AspNetCore.Mvc.ApiExplorer

アセンブリ:

Microsoft.AspNetCore.Mvc.Abstractions.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

このアプリケーションによって公開される API を表します。

public ref class ApiDescription

public class ApiDescription

type ApiDescription = class

Public Class ApiDescription

継承

Object

ApiDescription

コンストラクター

ApiDescription()

このアプリケーションによって公開される API を表します。

プロパティ

ActionDescriptor	この API のを取得または設定します ActionDescriptor 。
GroupName	この API のグループ名を取得または設定します。
HttpMethod	この API でサポートされている HTTP メソッドを取得または設定します。すべての HTTP メソッドがサポートされている場合は null を取得または設定します。
ParameterDescriptions	この API の の ApiParameterDescription 一覧を取得します。
Properties	に関連付けられている任意のメタデータ プロパティを取得します ApiDescription。
RelativePath	この API の相対 URL パス テンプレート (アプリケーション ルートに対する相対パス) を取得または設定します。
SupportedRequestFormats	要求に使用できる形式の一覧を取得します。
SupportedResponseTypes	応答に使用できる形式の一覧を取得します。

拡張メソッド

GetProperty<T>(ApiDescription)	指定した 値 をキーとして使用して、 Properties コレクションからプロパティの T 値を取得します。
SetProperty<T>(ApiDescription, T)	指定した 値 をキーとして使用して、 Properties コレクション内のプロパティの T 値を設定します。