OpenApiEndpointConventionBuilderExtensions.WithOpenApi Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| Nombre | Description |
|---|---|
| WithOpenApi<TBuilder>(TBuilder) |
Obsoletos.
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 especificado |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Obsoletos.
Agrega una anotación de OpenAPI a Metadata asociada al punto de conexión actual y la modifica con el especificado |
WithOpenApi<TBuilder>(TBuilder)
Precaución
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Agrega una anotación de OpenAPI a Metadata asociada al punto de conexión actual.
[System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")]
public static TBuilder WithOpenApi<TBuilder>(this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;public static TBuilder WithOpenApi<TBuilder>(this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;[<System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")>]
static member WithOpenApi : 'Builder -> 'Builder (requires 'Builder :> 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 TBuilderParámetros de tipo
- TBuilder
Parámetros
- builder
- TBuilder
Devoluciones
IEndpointConventionBuilder que se puede usar para personalizar aún más el punto de conexión.
- Atributos
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.
Se aplica a
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 especificado configureOperation.
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 TBuilderParámetros de tipo
- TBuilder
Parámetros
- builder
- TBuilder
- configureOperation
- Func<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation>
que Func<T,TResult> devuelve una nueva anotación de OpenAPI dada una operación generada.
Devoluciones
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.
Se aplica a
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Precaución
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Agrega una anotación de OpenAPI a Metadata asociada al punto de conexión actual y la modifica con el especificado configureOperation.
[System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")]
public static TBuilder WithOpenApi<TBuilder>(this TBuilder builder, Func<Microsoft.OpenApi.OpenApiOperation,Microsoft.OpenApi.OpenApiOperation> configureOperation) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;[<System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")>]
static member WithOpenApi : 'Builder * Func<Microsoft.OpenApi.OpenApiOperation, Microsoft.OpenApi.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 TBuilderParámetros de tipo
- TBuilder
Parámetros
- builder
- TBuilder
- configureOperation
- Func<OpenApiOperation,OpenApiOperation>
Delegado que personaliza los metadatos de la operación OpenAPI generados para el punto de conexión.
Devoluciones
IEndpointConventionBuilder que se puede usar para personalizar aún más el punto de conexión.
- Atributos
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.