OpenApiEndpointConventionBuilderExtensions.WithOpenApi Metoda

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Builder

Zestaw:

Microsoft.AspNetCore.OpenApi.dll

Pakiet:

Microsoft.AspNetCore.OpenApi v8.0.0

Przeciążenia

WithOpenApi<TBuilder>(TBuilder)	Dodaje adnotację interfejsu OpenAPI do Metadata skojarzonej z bieżącym punktem końcowym.
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	Dodaje adnotację interfejsu OpenAPI do Metadata skojarzonej z bieżącym punktem końcowym i modyfikuje ją przy użyciu danego configureOperation.

WithOpenApi<TBuilder>(TBuilder)

Źródło:

OpenApiEndpointConventionBuilderExtensions.cs

Dodaje adnotację interfejsu OpenAPI do Metadata skojarzonej z bieżącym punktem końcowym.

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

Parametry typu

TBuilder

Parametry

builder

TBuilder

IEndpointConventionBuilder.

Zwraca

TBuilder

IEndpointConventionBuilder, którego można użyć do dalszego dostosowywania punktu końcowego.

Uwagi

Ta metoda nie jest zintegrowana z wbudowaną obsługą generowania dokumentów OpenAPI w programie ASP.NET Core i jest przeznaczona głównie do użycia razem ze stroną struktury Swashbuckle.AspNetCore.

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

Źródło:

OpenApiEndpointConventionBuilderExtensions.cs

Dodaje adnotację interfejsu OpenAPI do Metadata skojarzonej z bieżącym punktem końcowym i modyfikuje ją przy użyciu danego 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

Parametry typu

TBuilder

Parametry

builder

TBuilder

IEndpointConventionBuilder.

configureOperation

Func<OpenApiOperation,OpenApiOperation>

Func<T,TResult>, który zwraca nową adnotację interfejsu OpenAPI na podstawie wygenerowanej operacji.

Zwraca

TBuilder

IEndpointConventionBuilder, którego można użyć do dalszego dostosowywania punktu końcowego.

Uwagi

Ta metoda nie jest zintegrowana z wbudowaną obsługą generowania dokumentów OpenAPI w programie ASP.NET Core i jest przeznaczona głównie do użycia razem ze stroną struktury Swashbuckle.AspNetCore.