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 包含適當的伺服器資訊。