IOpenApiDocumentProvider.GetOpenApiDocumentAsync(CancellationToken) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém o documento 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)Parâmetros
- cancellationToken
- CancellationToken
Um token a ser monitorado para solicitações de cancelamento.
Retornos
Uma tarefa que representa a operação assíncrona. O resultado da tarefa contém o documento OpenAPI.
Comentários
Esse método normalmente é usado pelos consumidores para recuperar o documento OpenAPI. O documento gerado pode não conter as informações apropriadas dos servidores, pois pode ser instanciado fora do contexto de uma solicitação HTTP. Nesses cenários, é OpenApiDocument possível modificar para incluir as informações apropriadas dos servidores.