OpenApiEndpointConventionBuilderExtensions.WithOpenApi Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
| Name | Beschreibung |
|---|---|
| WithOpenApi<TBuilder>(TBuilder) |
Veraltet.
Fügt dem aktuellen Endpunkt eine OpenAPI-Anmerkung hinzu Metadata . |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Fügt eine OpenAPI-Anmerkung hinzu, die Metadata dem aktuellen Endpunkt zugeordnet ist, und ändert sie mit dem angegebenen |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Veraltet.
Fügt eine OpenAPI-Anmerkung hinzu, die Metadata dem aktuellen Endpunkt zugeordnet ist, und ändert sie mit dem angegebenen |
WithOpenApi<TBuilder>(TBuilder)
Achtung
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Fügt dem aktuellen Endpunkt eine OpenAPI-Anmerkung hinzu Metadata .
[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 TBuilderTypparameter
- TBuilder
Parameter
- builder
- TBuilder
Gibt zurück
Eine IEndpointConventionBuilder , die verwendet werden kann, um den Endpunkt weiter anzupassen.
- Attribute
Hinweise
Diese Methode lässt sich nicht in die integrierte OpenAPI-Dokumentgenerierung in ASP.NET Core integrieren und ist in erster Linie für den Verbrauch entlang von Swashbuckle.AspNetCore vorgesehen.
Gilt für:
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Fügt eine OpenAPI-Anmerkung hinzu, die Metadata dem aktuellen Endpunkt zugeordnet ist, und ändert sie mit dem angegebenen 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 TBuilderTypparameter
- TBuilder
Parameter
- builder
- TBuilder
- configureOperation
- Func<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation>
Ein Wert Func<T,TResult> , der eine neue OpenAPI-Anmerkung mit einem generierten Vorgang zurückgibt.
Gibt zurück
Eine IEndpointConventionBuilder , die verwendet werden kann, um den Endpunkt weiter anzupassen.
Hinweise
Diese Methode lässt sich nicht in die integrierte OpenAPI-Dokumentgenerierung in ASP.NET Core integrieren und ist in erster Linie für den Verbrauch entlang von Swashbuckle.AspNetCore vorgesehen.
Gilt für:
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Achtung
WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.
Fügt eine OpenAPI-Anmerkung hinzu, die Metadata dem aktuellen Endpunkt zugeordnet ist, und ändert sie mit dem angegebenen 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 TBuilderTypparameter
- TBuilder
Parameter
- builder
- TBuilder
- configureOperation
- Func<OpenApiOperation,OpenApiOperation>
Ein Delegat, der die generierten OpenAPI-Vorgangsmetadaten für den Endpunkt angepasst.
Gibt zurück
Eine IEndpointConventionBuilder , die verwendet werden kann, um den Endpunkt weiter anzupassen.
- Attribute
Hinweise
Diese Methode lässt sich nicht in die integrierte OpenAPI-Dokumentgenerierung in ASP.NET Core integrieren und ist in erster Linie für den Verbrauch entlang von Swashbuckle.AspNetCore vorgesehen.