OpenApiEndpointConventionBuilderExtensions.WithOpenApi Método

Definição

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.OpenApi.dll

Pacote:

Microsoft.AspNetCore.OpenApi v8.0.0

Sobrecargas

WithOpenApi<TBuilder>(TBuilder)	Adiciona uma anotação OpenAPI a Metadata associada ao ponto de extremidade atual.
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	Adiciona uma anotação OpenAPI a Metadata associada ao ponto de extremidade atual e a modifica com o configureOperationfornecido.

WithOpenApi<TBuilder>(TBuilder)

Origem:

OpenApiEndpointConventionBuilderExtensions.cs

Adiciona uma anotação OpenAPI a Metadata associada ao ponto de extremidade atual.

public static TBuilder WithOpenApi<TBuilder> (this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

static member WithOpenApi : 'Builder -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)

<Extension()>
Public Function WithOpenApi(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder) As TBuilder

Parâmetros de tipo

TBuilder

Parâmetros

builder

TBuilder

O IEndpointConventionBuilder.

Retornos

TBuilder

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

Comentários

Esse método não se integra ao suporte interno à geração de documentos OpenAPI no ASP.NET Core e destina-se principalmente ao consumo junto com o Swashbuckle.AspNetCore.

WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)

Origem:

OpenApiEndpointConventionBuilderExtensions.cs

Adiciona uma anotação OpenAPI a Metadata associada ao ponto de extremidade atual e a modifica com o configureOperationfornecido.

public static TBuilder WithOpenApi<TBuilder> (this TBuilder builder, Func<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation> configureOperation) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

static member WithOpenApi : 'Builder * Func<Microsoft.OpenApi.Models.OpenApiOperation, Microsoft.OpenApi.Models.OpenApiOperation> -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)

<Extension()>
Public Function WithOpenApi(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, configureOperation As Func(Of OpenApiOperation, OpenApiOperation)) As TBuilder

Parâmetros de tipo

TBuilder

Parâmetros

builder

TBuilder

O IEndpointConventionBuilder.

configureOperation

Func<OpenApiOperation,OpenApiOperation>

Um Func<T,TResult> que retorna uma nova anotação OpenAPI dada uma operação gerada.

Retornos

TBuilder

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

Comentários

Esse método não se integra ao suporte interno à geração de documentos OpenAPI no ASP.NET Core e destina-se principalmente ao consumo junto com o Swashbuckle.AspNetCore.