EndpointDescriptionAttribute Classe

Definição

Namespace:

Microsoft.AspNetCore.Http

Assembly:

Microsoft.AspNetCore.Http.Extensions.dll

Pacote:

Microsoft.AspNetCore.App.Ref v8.0.0

Especifica uma descrição para o ponto de extremidade em 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

Herança

Attribute

EndpointDescriptionAttribute

Atributos

AttributeUsageAttribute

Implementações

IEndpointDescriptionMetadata

Comentários

A especificação OpenAPI dá suporte a um atributo de descrição em operações e parâmetros que podem ser usados para anotar pontos de extremidade com descritores detalhados e multilinha de seu comportamento.

Construtores

EndpointDescriptionAttribute(String)

Inicializa uma instância de EndpointDescriptionAttribute.

Propriedades

Description

Obtém a descrição associada ao ponto de extremidade.

Métodos

ToString()

Especifica uma descrição para o ponto de extremidade em Metadata.