OpenApiRouteHandlerBuilderExtensions.WithDescription<TBuilder> Método

Referência

Definição

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Routing.dll

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

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

Pacote:: Microsoft.AspNetCore.App.Ref v9.0.0

Origem:: OpenApiRouteHandlerBuilderExtensions.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Adiciona IEndpointDescriptionMetadata a para Metadata todos os pontos de extremidade produzidos por builder.

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

Parâmetros de tipo

TBuilder

Parâmetros

builder: TBuilder

O IEndpointConventionBuilder.

description: String

Uma cadeia de caracteres que representa uma descrição detalhada do ponto de extremidade.

Retornos

TBuilder

Um RouteHandlerBuilder que pode ser usado para personalizar ainda mais o ponto de extremidade.

Aplica-se a

Compartilhar via