JsonSerializationOutputFormatter Class

Definition

Namespace

Cuemon.Extensions.AspNetCore.Mvc.Formatters.Text.Json

Assemblies

Cuemon.Extensions.AspNetCore.Mvc.Formatters.Text.Json.dll

Source

src/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Text.Json/JsonSerializationOutputFormatter.cs

This class handles serialization of objects to JSON using JsonFormatter.

public class JsonSerializationOutputFormatter : StreamOutputFormatter<JsonFormatter, JsonFormatterOptions>, IOutputFormatter, IApiResponseTypeMetadataProvider, IConfigurable<JsonFormatterOptions>

Inheritance

object

OutputFormatter

TextOutputFormatter

ConfigurableOutputFormatter<JsonFormatterOptions>

StreamOutputFormatter<JsonFormatter, JsonFormatterOptions>

JsonSerializationOutputFormatter

Implements

IOutputFormatter

IApiResponseTypeMetadataProvider

IConfigurable<JsonFormatterOptions>

Inherited Members

StreamOutputFormatter<JsonFormatter, JsonFormatterOptions>.WriteResponseBodyAsync(OutputFormatterWriteContext, Encoding)

ConfigurableOutputFormatter<JsonFormatterOptions>.Options

TextOutputFormatter.SelectCharacterEncoding(OutputFormatterWriteContext)

TextOutputFormatter.WriteAsync(OutputFormatterWriteContext)

TextOutputFormatter.WriteResponseBodyAsync(OutputFormatterWriteContext)

TextOutputFormatter.WriteResponseBodyAsync(OutputFormatterWriteContext, Encoding)

TextOutputFormatter.SupportedEncodings

OutputFormatter.CanWriteType(Type)

OutputFormatter.GetSupportedContentTypes(string, Type)

OutputFormatter.CanWriteResult(OutputFormatterCanWriteContext)

OutputFormatter.WriteResponseHeaders(OutputFormatterWriteContext)

OutputFormatter.SupportedMediaTypes

Extension Methods

CacheableObjectResultExtensions.WithCacheableHeaders<T>(T, Action<CacheableObjectResultOptions<T>>)

CacheableObjectResultExtensions.WithEntityTagHeader<T>(T, Action<ContentBasedObjectResultOptions<T>>)

CacheableObjectResultExtensions.WithLastModifiedHeader<T>(T, Action<TimeBasedObjectResultOptions<T>>)

Examples

The following example demonstrates how to construct a and inspect its supported media types and encodings.

using System;
using System.Linq;
using Cuemon.Extensions.AspNetCore.Mvc.Formatters.Text.Json;
using Cuemon.Extensions.Text.Json.Formatters;

namespace DocfxExamples;

public class JsonSerializationOutputFormatterExample
{
    public void Demonstrate()
    {
        var options = new JsonFormatterOptions();
        var formatter = new JsonSerializationOutputFormatter(options);

        Console.WriteLine($"Supported media types: {string.Join(", ", formatter.SupportedMediaTypes)}");
        Console.WriteLine($"Supported encodings: {string.Join(", ", formatter.SupportedEncodings.Select(e => e.WebName))}");

}
}

Constructors

Name	Description
JsonSerializationOutputFormatter(JsonFormatterOptions)	Initializes a new instance of the JsonSerializationOutputFormatter class.