EndpointDescriptionAttribute Класс

Ссылка

Определение

Пространство имен:: Microsoft.AspNetCore.Http

Сборка:: Microsoft.AspNetCore.Http.Extensions.dll

Пакет:: Microsoft.AspNetCore.App.Ref v7.0.5

Пакет:: 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 поддерживает атрибут описания для операций и параметров, который можно использовать для заметок конечных точек с подробными многострочные дескрипторы их поведения.

Конструкторы

EndpointDescriptionAttribute(String)

Инициализирует экземпляр класса EndpointDescriptionAttribute.

Свойства

Description

Возвращает описание, связанное с конечной точкой.

Методы

ToString()

Задает описание конечной точки в Metadata.

Применяется к