OpenApiDocument.LoadAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| LoadAsync(String, OpenApiReaderSettings, CancellationToken) |
Parses a local file path or Url into an Open API document. |
| LoadAsync(Stream, String, OpenApiReaderSettings, CancellationToken) |
Reads the stream input and parses it into an Open API document. |
LoadAsync(String, OpenApiReaderSettings, CancellationToken)
- Source:
- OpenApiDocument.cs
Parses a local file path or Url into an Open API document.
public static System.Threading.Tasks.Task<Microsoft.OpenApi.Reader.ReadResult> LoadAsync(string url, Microsoft.OpenApi.Reader.OpenApiReaderSettings? settings = default, System.Threading.CancellationToken token = default);static member LoadAsync : string * Microsoft.OpenApi.Reader.OpenApiReaderSettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.OpenApi.Reader.ReadResult>Public Shared Function LoadAsync (url As String, Optional settings As OpenApiReaderSettings = Nothing, Optional token As CancellationToken = Nothing) As Task(Of ReadResult)Parameters
- url
- String
The path to the OpenAPI file.
- settings
- OpenApiReaderSettings
The OpenApi reader settings.
- token
- CancellationToken
The cancellation token
Returns
Applies to
LoadAsync(Stream, String, OpenApiReaderSettings, CancellationToken)
- Source:
- OpenApiDocument.cs
Reads the stream input and parses it into an Open API document.
public static System.Threading.Tasks.Task<Microsoft.OpenApi.Reader.ReadResult> LoadAsync(System.IO.Stream stream, string? format = default, Microsoft.OpenApi.Reader.OpenApiReaderSettings? settings = default, System.Threading.CancellationToken cancellationToken = default);static member LoadAsync : System.IO.Stream * string * Microsoft.OpenApi.Reader.OpenApiReaderSettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.OpenApi.Reader.ReadResult>Public Shared Function LoadAsync (stream As Stream, Optional format As String = Nothing, Optional settings As OpenApiReaderSettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ReadResult)Parameters
- stream
- Stream
Stream containing OpenAPI description to parse.
- format
- String
The OpenAPI format to use during parsing.
- settings
- OpenApiReaderSettings
The OpenApi reader settings.
- cancellationToken
- CancellationToken
Propagates information about operation cancelling.