Share via


RoutingEndpointConventionBuilderExtensions.WithName<TBuilder> Method

Definition

Adds the IEndpointNameMetadata to the Metadata collection for all endpoints produced on the target IEndpointConventionBuilder given the endpointName. The IEndpointNameMetadata on the endpoint is used for link generation and is treated as the operation ID in the given endpoint's OpenAPI specification.

public static TBuilder WithName<TBuilder> (this TBuilder builder, string endpointName) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member WithName : 'Builder * string -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function WithName(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, endpointName As String) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The IEndpointConventionBuilder.

endpointName
String

The endpoint name.

Returns

TBuilder

The IEndpointConventionBuilder.

Applies to