OpenApiEndpointConventionBuilderExtensions.WithOpenApi メソッド

定義

名前空間:

Microsoft.AspNetCore.Builder

アセンブリ:

Microsoft.AspNetCore.OpenApi.dll

パッケージ:

Microsoft.AspNetCore.OpenApi v10.0.0

オーバーロード

名前	説明
WithOpenApi<TBuilder>(TBuilder)	古い. 現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加します。
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	古い. 現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加し、指定された configureOperationで変更します。

WithOpenApi<TBuilder>(TBuilder)

ソース:

OpenApiEndpointConventionBuilderExtensions.cs

注意事項

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

現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加します。

[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;

[<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)

<Extension()>
Public Function WithOpenApi(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder) As TBuilder

型パラメーター

TBuilder

パラメーター

builder

TBuilder

IEndpointConventionBuilder。

返品

TBuilder

エンドポイントをさらにカスタマイズするために使用できる IEndpointConventionBuilder 。

属性

ObsoleteAttribute

注釈

このメソッドは、ASP.NET Core の組み込みの OpenAPI ドキュメント生成サポートとは統合されず、主にサイド Swashbuckle.AspNetCore と共に使用することを目的としています。

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

ソース:

OpenApiEndpointConventionBuilderExtensions.cs

注意事項

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

現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加し、指定された 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

エンドポイントをさらにカスタマイズするために使用できる IEndpointConventionBuilder 。

属性

ObsoleteAttribute

注釈

このメソッドは、ASP.NET Core の組み込みの OpenAPI ドキュメント生成サポートとは統合されず、主にサイド Swashbuckle.AspNetCore と共に使用することを目的としています。