OpenApiEndpointConventionBuilderExtensions.WithOpenApi 方法

定义

命名空间:: Microsoft.AspNetCore.Builder

程序集:: Microsoft.AspNetCore.OpenApi.dll

包:: Microsoft.AspNetCore.OpenApi v10.0.0

包:: Microsoft.AspNetCore.OpenApi v11.0.0-preview.5.26302.115

包:: Microsoft.AspNetCore.OpenApi v7.0.5

包:: Microsoft.AspNetCore.OpenApi v8.0.19

包:: Microsoft.AspNetCore.OpenApi v9.0.8

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

重载

名称	说明
WithOpenApi<TBuilder>(TBuilder)	已过时. 添加与当前终结点关联的 OpenAPI 批注 Metadata 。
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	将 OpenAPI 批注添加到 Metadata 与当前终结点关联的终结点，并使用给定 `configureOperation`的终结点对其进行修改。
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	已过时. 将 OpenAPI 批注添加到 Metadata 与当前终结点关联的终结点，并使用给定 `configureOperation`的终结点对其进行修改。

WithOpenApi<TBuilder>(TBuilder)

Source:: OpenApiEndpointConventionBuilderExtensions.cs

Source:: OpenApiEndpointConventionBuilderExtensions.cs

Source:: OpenApiEndpointConventionBuilderExtensions.cs

Source:: OpenApiEndpointConventionBuilderExtensions.cs

Source:: OpenApiEndpointConventionBuilderExtensions.cs

注意

WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.

添加与当前终结点关联的 OpenAPI 批注 Metadata 。

[System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")]
public static TBuilder WithOpenApi<TBuilder>(this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

public static TBuilder WithOpenApi<TBuilder>(this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

[<System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")>]
static member WithOpenApi : 'Builder -> 'Builder (requires 'Builder :> 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

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

属性: ObsoleteAttribute

注解

此方法不与 ASP.NET Core 中的内置 OpenAPI 文档生成支持集成，主要用于沿 Swashbuckle.AspNetCore 使用。

适用于

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

Source:: OpenApiEndpointConventionBuilderExtensions.cs

Source:: OpenApiEndpointConventionBuilderExtensions.cs

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<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation>

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

TBuilder

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

注解

此方法不与 ASP.NET Core 中的内置 OpenAPI 文档生成支持集成，主要用于沿 Swashbuckle.AspNetCore 使用。

适用于

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

Source:: OpenApiEndpointConventionBuilderExtensions.cs

Source:: OpenApiEndpointConventionBuilderExtensions.cs

注意

WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.

将 OpenAPI 批注添加到 Metadata 与当前终结点关联的终结点，并使用给定 configureOperation的终结点对其进行修改。

[System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")]
public static TBuilder WithOpenApi<TBuilder>(this TBuilder builder, Func<Microsoft.OpenApi.OpenApiOperation,Microsoft.OpenApi.OpenApiOperation> configureOperation) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

[<System.Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId="ASPDEPR002", UrlFormat="https://aka.ms/aspnet/deprecate/002")>]
static member WithOpenApi : 'Builder * Func<Microsoft.OpenApi.OpenApiOperation, Microsoft.OpenApi.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>

一个委托，用于自定义终结点生成的 OpenAPI 操作元数据。

TBuilder

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

属性: ObsoleteAttribute

注解

此方法不与 ASP.NET Core 中的内置 OpenAPI 文档生成支持集成，主要用于沿 Swashbuckle.AspNetCore 使用。

适用于

反馈

此页面是否有帮助？