JsonOutputFormatter Class¶

Namespace

Microsoft.AspNetCore.Mvc.Formatters

Assemblies

Inheritance Hierarchy ¶

public class JsonOutputFormatter : TextOutputFormatter, IOutputFormatter, IApiResponseTypeMetadataProvider

JsonOutputFormatter(Newtonsoft.Json.JsonSerializerSettings, System.Buffers.ArrayPool<System.Char>)¶

Arguments:

serializerSettings (Newtonsoft.Json.JsonSerializerSettings) – The Newtonsoft.Json.JsonSerializerSettings. Should be either the application-wide settings ( Microsoft.AspNetCore.Mvc.MvcJsonOptions.SerializerSettings) or an instance Microsoft.AspNetCore.Mvc.Formatters.JsonSerializerSettingsProvider.CreateSerializerSettings initially returned.
charPool (System.Buffers.ArrayPool<System.Char>) – The System.Buffers.ArrayPool`1.

public JsonOutputFormatter(JsonSerializerSettings serializerSettings, ArrayPool<char> charPool)

CreateJsonSerializer()¶

Called during serialization to create the Newtonsoft.Json.JsonSerializer.

Return type:	Newtonsoft.Json.JsonSerializer
Returns:	The `Newtonsoft.Json.JsonSerializer` used during serialization and deserialization.

protected virtual JsonSerializer CreateJsonSerializer()

CreateJsonWriter(System.IO.TextWriter)¶

Called during serialization to create the Newtonsoft.Json.JsonWriter.

Arguments:	writer (System.IO.TextWriter) – The `System.IO.TextWriter` used to write.
Return type:	Newtonsoft.Json.JsonWriter
Returns:	The `Newtonsoft.Json.JsonWriter` used during serialization.

protected virtual JsonWriter CreateJsonWriter(TextWriter writer)

WriteObject(System.IO.TextWriter, System.Object)¶

Writes the given <em>value</em> as JSON using the given <em>writer</em>.

Arguments:	writer (System.IO.TextWriter) – The `System.IO.TextWriter` used to write the <em>value</em> value (System.Object) – The value to write as JSON.

public void WriteObject(TextWriter writer, object value)

WriteResponseBodyAsync(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext, System.Text.Encoding)¶

Return type:	System.Threading.Tasks.Task

public override Task WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)

Microsoft.AspNetCore.Mvc.Formatters.JsonOutputFormatter.SerializerSettings¶

Gets the Newtonsoft.Json.JsonSerializerSettings used to configure the Newtonsoft.Json.JsonSerializer.

Return type:	Newtonsoft.Json.JsonSerializerSettings

protected JsonSerializerSettings SerializerSettings { get; }