EndpointDescriptionAttribute Classe

Référence

Définition

Espace de noms:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.Extensions.dll

Paquet:: Microsoft.AspNetCore.App.Ref v7.0.5

Paquet:: Microsoft.AspNetCore.App.Ref v8.0.0

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Spécifie une description du point de terminaison dans 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

Héritage: Attribute
EndpointDescriptionAttribute

Attributs: AttributeUsageAttribute

Implémente: IEndpointDescriptionMetadata

Remarques

La spécification OpenAPI prend en charge un attribut de description sur les opérations et les paramètres qui peuvent être utilisés pour annoter des points de terminaison avec des descripteurs multilignes détaillés de leur comportement.

Constructeurs

EndpointDescriptionAttribute(String)

Initialise une instance de la classe EndpointDescriptionAttribute.

Propriétés

Description

Obtient la description associée au point de terminaison.

Méthodes

ToString()