OpenApiSerializableExtensions.SerializeAsync 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 |
|---|---|
| SerializeAsync<T>(T, IOpenApiWriter, OpenApiSpecVersion, CancellationToken) |
Serializes the IOpenApiSerializable to Open API document using the given specification version and writer. |
| SerializeAsync<T>(T, OpenApiSpecVersion, String, CancellationToken) |
Serializes the IOpenApiSerializable to the Open API document as a string in the given format. |
| SerializeAsync<T>(T, Stream, OpenApiSpecVersion, String, CancellationToken) |
Serializes the IOpenApiSerializable to the Open API document using the given stream, specification version and the format. |
| SerializeAsync<T>(T, Stream, OpenApiSpecVersion, String, OpenApiWriterSettings, CancellationToken) |
Serializes the IOpenApiSerializable to the Open API document using the given stream, specification version and the format. |
SerializeAsync<T>(T, IOpenApiWriter, OpenApiSpecVersion, CancellationToken)
Serializes the IOpenApiSerializable to Open API document using the given specification version and writer.
public static System.Threading.Tasks.Task SerializeAsync<T>(this T element, Microsoft.OpenApi.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion, System.Threading.CancellationToken cancellationToken = default) where T : Microsoft.OpenApi.IOpenApiSerializable;static member SerializeAsync : 'T * Microsoft.OpenApi.IOpenApiWriter * Microsoft.OpenApi.OpenApiSpecVersion * System.Threading.CancellationToken -> System.Threading.Tasks.Task (requires 'T :> Microsoft.OpenApi.IOpenApiSerializable)<Extension()>
Public Function SerializeAsync(Of T As IOpenApiSerializable) (element As T, writer As IOpenApiWriter, specVersion As OpenApiSpecVersion, Optional cancellationToken As CancellationToken = Nothing) As TaskType Parameters
- T
Parameters
- element
- T
The Open API element.
- writer
- IOpenApiWriter
The output writer.
- specVersion
- OpenApiSpecVersion
Version of the specification the output should conform to
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Applies to
SerializeAsync<T>(T, OpenApiSpecVersion, String, CancellationToken)
Serializes the IOpenApiSerializable to the Open API document as a string in the given format.
public static System.Threading.Tasks.Task<string> SerializeAsync<T>(this T element, Microsoft.OpenApi.OpenApiSpecVersion specVersion, string format, System.Threading.CancellationToken cancellationToken = default) where T : Microsoft.OpenApi.IOpenApiSerializable;static member SerializeAsync : 'T * Microsoft.OpenApi.OpenApiSpecVersion * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string> (requires 'T :> Microsoft.OpenApi.IOpenApiSerializable)<Extension()>
Public Function SerializeAsync(Of T As IOpenApiSerializable) (element As T, specVersion As OpenApiSpecVersion, format As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)Type Parameters
- T
Parameters
- element
- T
The Open API element.
- specVersion
- OpenApiSpecVersion
The Open API specification version.
- format
- String
Open API document format.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Applies to
SerializeAsync<T>(T, Stream, OpenApiSpecVersion, String, CancellationToken)
Serializes the IOpenApiSerializable to the Open API document using the given stream, specification version and the format.
public static System.Threading.Tasks.Task SerializeAsync<T>(this T element, System.IO.Stream stream, Microsoft.OpenApi.OpenApiSpecVersion specVersion, string format, System.Threading.CancellationToken cancellationToken = default) where T : Microsoft.OpenApi.IOpenApiSerializable;static member SerializeAsync : 'T * System.IO.Stream * Microsoft.OpenApi.OpenApiSpecVersion * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task (requires 'T :> Microsoft.OpenApi.IOpenApiSerializable)<Extension()>
Public Function SerializeAsync(Of T As IOpenApiSerializable) (element As T, stream As Stream, specVersion As OpenApiSpecVersion, format As String, Optional cancellationToken As CancellationToken = Nothing) As TaskType Parameters
- T
Parameters
- element
- T
The Open API element.
- stream
- Stream
The given stream.
- specVersion
- OpenApiSpecVersion
The Open API specification version.
- format
- String
The output format (JSON or YAML).
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Applies to
SerializeAsync<T>(T, Stream, OpenApiSpecVersion, String, OpenApiWriterSettings, CancellationToken)
Serializes the IOpenApiSerializable to the Open API document using the given stream, specification version and the format.
public static System.Threading.Tasks.Task SerializeAsync<T>(this T element, System.IO.Stream stream, Microsoft.OpenApi.OpenApiSpecVersion specVersion, string format, Microsoft.OpenApi.OpenApiWriterSettings? settings = default, System.Threading.CancellationToken cancellationToken = default) where T : Microsoft.OpenApi.IOpenApiSerializable;static member SerializeAsync : 'T * System.IO.Stream * Microsoft.OpenApi.OpenApiSpecVersion * string * Microsoft.OpenApi.OpenApiWriterSettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task (requires 'T :> Microsoft.OpenApi.IOpenApiSerializable)<Extension()>
Public Function SerializeAsync(Of T As IOpenApiSerializable) (element As T, stream As Stream, specVersion As OpenApiSpecVersion, format As String, Optional settings As OpenApiWriterSettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskType Parameters
- T
Parameters
- element
- T
The Open API element.
- stream
- Stream
The given stream.
- specVersion
- OpenApiSpecVersion
The Open API specification version.
- format
- String
The output format (JSON or YAML).
- settings
- OpenApiWriterSettings
Provide configuration settings for controlling writing output
- cancellationToken
- CancellationToken
The cancellation token.