OpenApiEndpointConventionBuilderExtensions.WithOpenApi Método
Definição
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.
Sobrecargas
| Nome | Description |
|---|---|
| WithOpenApi<TBuilder>(TBuilder) |
Obsoleto.
Adiciona uma anotação OpenAPI a Metadata ser associada ao ponto de extremidade atual. |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Adiciona uma anotação OpenAPI a ser associada ao Metadata ponto de extremidade atual e a modifica com o determinado |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Obsoleto.
Adiciona uma anotação OpenAPI a ser associada ao Metadata ponto de extremidade atual e a modifica com o determinado |
WithOpenApi<TBuilder>(TBuilder)
Cuidado
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Adiciona uma anotação OpenAPI a Metadata ser associada ao ponto de extremidade atual.
[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
Retornos
Um IEndpointConventionBuilder que pode ser usado para personalizar ainda mais o ponto de extremidade.
- Atributos
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.
Aplica-se a
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Adiciona uma anotação OpenAPI a ser associada ao Metadata ponto de extremidade atual e a modifica com o determinado 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>
Um Func<T,TResult> que retorna uma nova anotação OpenAPI dada uma operação gerada.
Retornos
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.
Aplica-se a
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Cuidado
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Adiciona uma anotação OpenAPI a ser associada ao Metadata ponto de extremidade atual e a modifica com o determinado 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>
Um delegado que personaliza os metadados de operação OpenAPI gerados para o ponto de extremidade.
Retornos
Um IEndpointConventionBuilder que pode ser usado para personalizar ainda mais o ponto de extremidade.
- Atributos
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.