OpenApiEndpointConventionBuilderExtensions.WithOpenApi Methode

Definition

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.OpenApi.dll

Paket:

Microsoft.AspNetCore.OpenApi v8.0.0

Ü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 configureOperation.

WithOpenApi<TBuilder>(TBuilder)

Quelle:

OpenApiEndpointConventionBuilderExtensions.cs

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 TBuilder

Typparameter

TBuilder

Parameter

builder

TBuilder

Die IEndpointConventionBuilder.

Gibt zurück

TBuilder

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.

WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)

Quelle:

OpenApiEndpointConventionBuilderExtensions.cs

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 TBuilder

Typparameter

TBuilder

Parameter

builder

TBuilder

Die IEndpointConventionBuilder.

configureOperation

Func<OpenApiOperation,OpenApiOperation>

Eine Func<T,TResult>, die eine neue OpenAPI-Anmerkung mit einem generierten Vorgang zurückgibt.

Gibt zurück

TBuilder

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.