OpenApiEndpointConventionBuilderExtensions.WithOpenApi 方法

定义

命名空间:

Microsoft.AspNetCore.Builder

程序集:

Microsoft.AspNetCore.OpenApi.dll

包:

Microsoft.AspNetCore.OpenApi v8.0.0

重载

WithOpenApi<TBuilder>(TBuilder)	将 OpenAPI 注释添加到 Metadata 与当前终结点关联的 。
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	将 OpenAPI 注释添加到 Metadata 与当前终结点关联的 ，并使用给定 configureOperation的 对其进行修改。

WithOpenApi<TBuilder>(TBuilder)

Source:

OpenApiEndpointConventionBuilderExtensions.cs

将 OpenAPI 注释添加到 Metadata 与当前终结点关联的 。

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

类型参数

TBuilder

参数

builder

TBuilder

IEndpointConventionBuilder。

返回

TBuilder

可用于 IEndpointConventionBuilder 进一步自定义终结点的 。

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

Source:

OpenApiEndpointConventionBuilderExtensions.cs

将 OpenAPI 注释添加到 Metadata 与当前终结点关联的 ，并使用给定 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

类型参数

TBuilder

参数

builder

TBuilder

IEndpointConventionBuilder。

configureOperation

Func<OpenApiOperation,OpenApiOperation>

一个 ， Func<T,TResult> 在给定生成的操作的情况下返回新的 OpenAPI 批注。

返回

TBuilder

可用于 IEndpointConventionBuilder 进一步自定义终结点的 。