EndpointDescriptionAttribute Klasse

Referenz

Definition

Namespace:: Microsoft.AspNetCore.Http

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

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

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

Paket:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Quelle:: EndpointDescriptionAttribute.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

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

EndpointDescriptionAttribute(String)

Initialisiert eine Instanz der EndpointDescriptionAttribute-Klasse.

Eigenschaften

Description

Ruft die Dem Endpunkt zugeordnete Beschreibung ab.

Methoden

ToString()

Gibt eine Beschreibung für den Endpunkt in Metadataan.

Gilt für:

Freigeben über