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	取得或設定 ActionDescriptor 此 API。
GroupName	取得或設定此 API 的組名。
HttpMethod	取得或設定此 API 支援的 HTTP 方法，如果支援所有 HTTP 方法，則為 null。
ParameterDescriptions	取得此 API 的 ApiParameterDescription 清單。
Properties	取得與 相關聯的 ApiDescription 任意中繼資料屬性。
RelativePath	取得或設定相對於此 API 之應用程式根目錄) 的相對 URL 路徑範本 (。
SupportedRequestFormats	取得要求的可能格式清單。
SupportedResponseTypes	取得回應的可能格式清單。

擴充方法

GetProperty<T>(ApiDescription)	使用 提供的 值 T 做為索引鍵，從 Properties 集合取得 屬性值。
SetProperty<T>(ApiDescription, T)	使用 提供的 值 T 做為索引鍵，設定集合中 Properties 屬性值。