OpenApiRouteHandlerBuilderExtensions.WithDescription<TBuilder> Methode

Referenz

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Routing.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-preview.4.24267.6

Quelle:: OpenApiRouteHandlerBuilderExtensions.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.

Fügt IEndpointDescriptionMetadata zu Metadata für alle von buildererzeugten Endpunkte hinzu.

public static TBuilder WithDescription<TBuilder> (this TBuilder builder, string description) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

static member WithDescription : 'Builder * string -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)

<Extension()>
Public Function WithDescription(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, description As String) As TBuilder

Typparameter

TBuilder

Parameter

builder: TBuilder

Die IEndpointConventionBuilder.

description: String

Eine Zeichenfolge, die eine detaillierte Beschreibung des Endpunkts darstellt.

Gibt zurück

TBuilder

Ein RouteHandlerBuilder , der verwendet werden kann, um den Endpunkt weiter anzupassen.

Gilt für:

Freigeben über