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