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)	使用提供的 值作为键，从 Properties 集合中获取属性的值 T 。
SetProperty<T>(ApiDescription, T)	使用提供的 值作为键设置集合中 Properties 属性的值 T 。