OpenApiEndpointConventionBuilderExtensions.WithOpenApi Yöntem

Tanım

Ad Alanı:

Microsoft.AspNetCore.Builder

Bütünleştirilmiş Kod:

Microsoft.AspNetCore.OpenApi.dll

Paket:

Microsoft.AspNetCore.OpenApi v8.0.0

Aşırı Yüklemeler

WithOpenApi<TBuilder>(TBuilder)	Geçerli uç noktayla ilişkili Metadata bir OpenAPI ek açıklaması ekler.
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	Geçerli uç noktayla ilişkili Metadata bir OpenAPI ek açıklaması ekler ve bunu verilen configureOperationile değiştirir.

WithOpenApi<TBuilder>(TBuilder)

Kaynak:

OpenApiEndpointConventionBuilderExtensions.cs

Geçerli uç noktayla ilişkili Metadata bir OpenAPI ek açıklaması ekler.

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

Tür Parametreleri

TBuilder

Parametreler

builder

TBuilder

IEndpointConventionBuilder.

Döndürülenler

TBuilder

Uç noktayı daha fazla özelleştirmek için kullanılabilecek bir IEndpointConventionBuilder.

Açıklamalar

Bu yöntem, ASP.NET Core'daki yerleşik OpenAPI belge oluşturma desteğiyle tümleştirilmez ve öncelikle Swashbuckle.AspNetCore ile birlikte kullanıma yöneliktir.

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

Kaynak:

OpenApiEndpointConventionBuilderExtensions.cs

Geçerli uç noktayla ilişkili Metadata bir OpenAPI ek açıklaması ekler ve bunu verilen configureOperationile değiştirir.

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

Tür Parametreleri

TBuilder

Parametreler

builder

TBuilder

IEndpointConventionBuilder.

configureOperation

Func<OpenApiOperation,OpenApiOperation>

Oluşturulan bir işlem verilip yeni bir OpenAPI ek açıklaması döndüren bir Func<T,TResult>.

Döndürülenler

TBuilder

Uç noktayı daha fazla özelleştirmek için kullanılabilecek bir IEndpointConventionBuilder.

Açıklamalar

Bu yöntem, ASP.NET Core'daki yerleşik OpenAPI belge oluşturma desteğiyle tümleştirilmez ve öncelikle Swashbuckle.AspNetCore ile birlikte kullanıma yöneliktir.