OpenApiEndpointConventionBuilderExtensions.WithOpenApi Método

Definición

Espacio de nombres:

Microsoft.AspNetCore.Builder

Ensamblado:

Microsoft.AspNetCore.OpenApi.dll

Paquete:

Microsoft.AspNetCore.OpenApi v8.0.0

Sobrecargas

WithOpenApi<TBuilder>(TBuilder)	Agrega una anotación de OpenAPI a Metadata asociada al punto de conexión actual.
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	Agrega una anotación de OpenAPI a Metadata asociada al punto de conexión actual y la modifica con el configureOperationespecificado.

WithOpenApi<TBuilder>(TBuilder)

Source:

OpenApiEndpointConventionBuilderExtensions.cs

Agrega una anotación de OpenAPI a Metadata asociada al punto de conexión actual.

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

El IEndpointConventionBuilder.

Devoluciones

TBuilder

Un IEndpointConventionBuilder que se puede usar para personalizar aún más el punto de conexión.

Comentarios

Este método no se integra con la compatibilidad integrada de generación de documentos de OpenAPI en ASP.NET Core y está pensada principalmente para el consumo a lo largo del lado de Swashbuckle.AspNetCore.

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

Source:

OpenApiEndpointConventionBuilderExtensions.cs

Agrega una anotación de OpenAPI a Metadata asociada al punto de conexión actual y la modifica con el configureOperationespecificado.

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

El IEndpointConventionBuilder.

configureOperation

Func<OpenApiOperation,OpenApiOperation>

Un Func<T,TResult> que devuelve una nueva anotación de OpenAPI dada una operación generada.

Devoluciones

TBuilder

Un IEndpointConventionBuilder que se puede usar para personalizar aún más el punto de conexión.

Comentarios

Este método no se integra con la compatibilidad integrada de generación de documentos de OpenAPI en ASP.NET Core y está pensada principalmente para el consumo a lo largo del lado de Swashbuckle.AspNetCore.