OpenApiEndpointConventionBuilderExtensions.WithOpenApi Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Overload
| Nome | Descrizione |
|---|---|
| WithOpenApi<TBuilder>(TBuilder) |
Obsoleti.
Aggiunge un'annotazione OpenAPI a associata all'endpoint Metadata corrente. |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Aggiunge un'annotazione OpenAPI a associata all'endpoint Metadata corrente e la modifica con l'oggetto specificato |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Obsoleti.
Aggiunge un'annotazione OpenAPI a associata all'endpoint Metadata corrente e la modifica con l'oggetto specificato |
WithOpenApi<TBuilder>(TBuilder)
Attenzione
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Aggiunge un'annotazione OpenAPI a associata all'endpoint Metadata corrente.
[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 TBuilderParametri di tipo
- TBuilder
Parametri
- builder
- TBuilder
Valori restituiti
Oggetto IEndpointConventionBuilder che può essere usato per personalizzare ulteriormente l'endpoint.
- Attributi
Commenti
Questo metodo non si integra con il supporto predefinito per la generazione di documenti OpenAPI in ASP.NET Core ed è destinato principalmente all'utilizzo lungo il lato Swashbuckle.AspNetCore.
Si applica a
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Aggiunge un'annotazione OpenAPI a associata all'endpoint Metadata corrente e la modifica con l'oggetto specificato 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 TBuilderParametri di tipo
- TBuilder
Parametri
- builder
- TBuilder
- configureOperation
- Func<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation>
Oggetto che restituisce Func<T,TResult> una nuova annotazione OpenAPI in base a un'operazione generata.
Valori restituiti
Oggetto IEndpointConventionBuilder che può essere usato per personalizzare ulteriormente l'endpoint.
Commenti
Questo metodo non si integra con il supporto predefinito per la generazione di documenti OpenAPI in ASP.NET Core ed è destinato principalmente all'utilizzo lungo il lato Swashbuckle.AspNetCore.
Si applica a
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Attenzione
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Aggiunge un'annotazione OpenAPI a associata all'endpoint Metadata corrente e la modifica con l'oggetto specificato 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 TBuilderParametri di tipo
- TBuilder
Parametri
- builder
- TBuilder
- configureOperation
- Func<OpenApiOperation,OpenApiOperation>
Delegato che personalizza i metadati dell'operazione OpenAPI generati per l'endpoint.
Valori restituiti
Oggetto IEndpointConventionBuilder che può essere usato per personalizzare ulteriormente l'endpoint.
- Attributi
Commenti
Questo metodo non si integra con il supporto predefinito per la generazione di documenti OpenAPI in ASP.NET Core ed è destinato principalmente all'utilizzo lungo il lato Swashbuckle.AspNetCore.