EndpointDescriptionAttribute Klasse

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Http.Extensions.dll
Paket:
Microsoft.AspNetCore.App.Ref v10.0.0-preview.6.25358.103
Paket:
Microsoft.AspNetCore.App.Ref v7.0.5
Paket:
Microsoft.AspNetCore.App.Ref v8.0.0
Paket:
Microsoft.AspNetCore.App.Ref v9.0.2
Quelle:
EndpointDescriptionAttribute.cs

Gibt eine Beschreibung für den Endpunkt in Metadataan.

[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
Vererbung
Attribute
EndpointDescriptionAttribute
Attribute
AttributeUsageAttribute
Implementiert
IEndpointDescriptionMetadata

Hinweise

Die OpenAPI-Spezifikation unterstützt ein Beschreibungsattribut für Vorgänge und Parameter, die verwendet werden können, um Endpunkte mit detaillierten mehrteiligen Deskriptoren ihres Verhaltens zu kommentieren.

Konstruktoren

Name Beschreibung
EndpointDescriptionAttribute(String)

Initialisiert eine Instanz der EndpointDescriptionAttribute-Klasse.

Eigenschaften

Name Beschreibung
Description

Ruft die Dem Endpunkt zugeordnete Beschreibung ab.

Methoden

Name Beschreibung
ToString()

Gibt eine Beschreibung für den Endpunkt in Metadataan.

Gilt für: