IOpenApiDocumentProvider.GetOpenApiDocumentAsync(CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
OpenAPI ドキュメントを取得します。
public System.Threading.Tasks.Task<Microsoft.OpenApi.OpenApiDocument> GetOpenApiDocumentAsync(System.Threading.CancellationToken cancellationToken = default);abstract member GetOpenApiDocumentAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.OpenApi.OpenApiDocument>Public Function GetOpenApiDocumentAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of OpenApiDocument)パラメーター
- cancellationToken
- CancellationToken
キャンセル要求を監視するトークン。
戻り値
非同期操作を表すタスク。 タスクの結果には、OpenAPI ドキュメントが含まれます。
注釈
このメソッドは通常、コンシューマーが OpenAPI ドキュメントを取得するために使用されます。 生成されたドキュメントには、HTTP 要求のコンテキスト外でインスタンス化できるため、適切なサーバー情報が含まれていない可能性があります。 これらのシナリオでは、 OpenApiDocument を変更して、適切なサーバー情報を含めることができます。