IOpenApiDocumentProvider.GetOpenApiDocumentAsync(CancellationToken) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает документ 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 чтобы включить соответствующие сведения о серверах.