OpenApiEndpointConventionBuilderExtensions.WithOpenApi Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| Nom | Description |
|---|---|
| WithOpenApi<TBuilder>(TBuilder) |
Obsolète.
Ajoute une annotation OpenAPI à Metadata associée au point de terminaison actuel. |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Ajoute une annotation OpenAPI à Metadata associée au point de terminaison actuel et la modifie avec le point de terminaison donné |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Obsolète.
Ajoute une annotation OpenAPI à Metadata associée au point de terminaison actuel et la modifie avec le point de terminaison donné |
WithOpenApi<TBuilder>(TBuilder)
Attention
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Ajoute une annotation OpenAPI à Metadata associée au point de terminaison actuel.
[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 TBuilderParamètres de type
- TBuilder
Paramètres
- builder
- TBuilder
Retours
Qui IEndpointConventionBuilder peut être utilisé pour personnaliser davantage le point de terminaison.
- Attributs
Remarques
Cette méthode ne s’intègre pas à la prise en charge intégrée de la génération de documents OpenAPI dans ASP.NET Core et est principalement destinée à la consommation côte à côte de Swashbuckle.AspNetCore.
S’applique à
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Ajoute une annotation OpenAPI à Metadata associée au point de terminaison actuel et la modifie avec le point de terminaison donné 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 TBuilderParamètres de type
- TBuilder
Paramètres
- builder
- TBuilder
- configureOperation
- Func<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation>
Qui Func<T,TResult> retourne une nouvelle annotation OpenAPI en fonction d’une opération générée.
Retours
Qui IEndpointConventionBuilder peut être utilisé pour personnaliser davantage le point de terminaison.
Remarques
Cette méthode ne s’intègre pas à la prise en charge intégrée de la génération de documents OpenAPI dans ASP.NET Core et est principalement destinée à la consommation côte à côte de Swashbuckle.AspNetCore.
S’applique à
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Attention
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Ajoute une annotation OpenAPI à Metadata associée au point de terminaison actuel et la modifie avec le point de terminaison donné 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 TBuilderParamètres de type
- TBuilder
Paramètres
- builder
- TBuilder
- configureOperation
- Func<OpenApiOperation,OpenApiOperation>
Délégué qui personnalise les métadonnées d’opération OpenAPI générées pour le point de terminaison.
Retours
Qui IEndpointConventionBuilder peut être utilisé pour personnaliser davantage le point de terminaison.
- Attributs
Remarques
Cette méthode ne s’intègre pas à la prise en charge intégrée de la génération de documents OpenAPI dans ASP.NET Core et est principalement destinée à la consommation côte à côte de Swashbuckle.AspNetCore.