OpenApiEndpointConventionBuilderExtensions.WithOpenApi メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 名前 | 説明 |
|---|---|
| WithOpenApi<TBuilder>(TBuilder) |
古い.
現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加します。 |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加し、指定された |
| WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
古い.
現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加し、指定された |
WithOpenApi<TBuilder>(TBuilder)
注意事項
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;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 。
- 属性
注釈
このメソッドは、ASP.NET Core の組み込みの OpenAPI ドキュメント生成サポートとは統合されず、主にサイド Swashbuckle.AspNetCore と共に使用することを目的としています。
適用対象
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加し、指定された 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
- configureOperation
- Func<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation>
生成された操作で新しい OpenAPI 注釈を返す Func<T,TResult> 。
返品
エンドポイントをさらにカスタマイズするために使用できる IEndpointConventionBuilder 。
注釈
このメソッドは、ASP.NET Core の組み込みの OpenAPI ドキュメント生成サポートとは統合されず、主にサイド Swashbuckle.AspNetCore と共に使用することを目的としています。
適用対象
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
注意事項
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
- configureOperation
- Func<OpenApiOperation,OpenApiOperation>
エンドポイントの生成された OpenAPI 操作メタデータをカスタマイズするデリゲート。
返品
エンドポイントをさらにカスタマイズするために使用できる IEndpointConventionBuilder 。
- 属性
注釈
このメソッドは、ASP.NET Core の組み込みの OpenAPI ドキュメント生成サポートとは統合されず、主にサイド Swashbuckle.AspNetCore と共に使用することを目的としています。