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
| WithOpenApi<TBuilder>(TBuilder) |
Fügt eine OpenAPI-Anmerkung zu Metadata hinzu, die dem aktuellen Endpunkt zugeordnet ist. |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Fügt eine OpenAPI-Anmerkung zu Metadata hinzu, die dem aktuellen Endpunkt zugeordnet ist, und ändert sie mit dem angegebenen |
WithOpenApi<TBuilder>(TBuilder)
Fügt eine OpenAPI-Anmerkung zu Metadata hinzu, die dem aktuellen Endpunkt zugeordnet ist.
public static TBuilder WithOpenApi<TBuilder> (this TBuilder builder) where TBuilder : 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.
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 zu Metadata hinzu, die 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<OpenApiOperation,OpenApiOperation>
Eine Func<T,TResult>, die 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.