OpenApiRouteHandlerBuilderExtensions.WithTags Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.0-preview.5.22303.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds the ITagsMetadata to Metadata for all endpoints produced by builder.

public static Microsoft.AspNetCore.Builder.RouteHandlerBuilder WithTags (this Microsoft.AspNetCore.Builder.RouteHandlerBuilder builder, params string[] tags);

static member WithTags : Microsoft.AspNetCore.Builder.RouteHandlerBuilder * string[] -> Microsoft.AspNetCore.Builder.RouteHandlerBuilder

<Extension()>
Public Function WithTags (builder As RouteHandlerBuilder, ParamArray tags As String()) As RouteHandlerBuilder

Parameters

builder: RouteHandlerBuilder

The RouteHandlerBuilder.

tags: String[]

A collection of tags to be associated with the endpoint.

Returns

RouteHandlerBuilder

A RouteHandlerBuilder that can be used to further customize the endpoint.

Remarks

The OpenAPI specification supports a tags classification to categorize operations into related groups. These tags are typically included in the generated specification and are typically used to group operations by tags in the UI.

Applies to