EndpointDescriptionAttribute 类

定义

命名空间:

Microsoft.AspNetCore.Http

程序集:

Microsoft.AspNetCore.Http.Extensions.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

指定 中 Metadata终结点的说明。

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
public sealed class EndpointDescriptionAttribute : Attribute, Microsoft.AspNetCore.Http.Metadata.IEndpointDescriptionMetadata

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
type EndpointDescriptionAttribute = class
    inherit Attribute
    interface IEndpointDescriptionMetadata

Public NotInheritable Class EndpointDescriptionAttribute
Inherits Attribute
Implements IEndpointDescriptionMetadata

继承

Attribute

EndpointDescriptionAttribute

属性

AttributeUsageAttribute

实现

IEndpointDescriptionMetadata

注解

OpenAPI 规范支持操作和参数的 description 属性，这些属性可用于使用终结点行为的详细多行描述符进行批注。

构造函数

EndpointDescriptionAttribute(String)

初始化 EndpointDescriptionAttribute 的实例。

属性

Description

获取与终结点关联的说明。

方法

ToString()

指定 中 Metadata终结点的说明。