IOpenApiDocumentProvider.GetOpenApiDocumentAsync(CancellationToken) Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Ottiene il 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)
Parametri
- cancellationToken
- CancellationToken
Token da monitorare per le richieste di annullamento.
Restituisce
Attività che rappresenta l'operazione asincrona. Il risultato dell'attività contiene il documento OpenAPI.
Commenti
Questo metodo viene in genere usato dai consumer per recuperare il documento OpenAPI. Il documento generato potrebbe non contenere le informazioni appropriate sui server perché può essere creata un'istanza all'esterno del contesto di una richiesta HTTP. In questi scenari, è possibile modificare per OpenApiDocument includere le informazioni sui server appropriate.