Class JsonApiInputFormatter

Namespace

JsonApiDotNetCore.Middleware

Assembly

JsonApiDotNetCore.dll

Application-wide entry point for reading JSON:API request bodies.

public sealed class JsonApiInputFormatter : IJsonApiInputFormatter, IInputFormatter

Inheritance

object

JsonApiInputFormatter

Implements

IJsonApiInputFormatter

IInputFormatter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CanRead(InputFormatterContext)

Determines whether this IInputFormatter can deserialize an object of the context's ModelType.

public bool CanRead(InputFormatterContext context)

Parameters

context InputFormatterContext

The InputFormatterContext.

Returns

bool

true if this IInputFormatter can deserialize an object of the context's ModelType. false otherwise.

ReadAsync(InputFormatterContext)

Reads an object from the request body.

public Task<InputFormatterResult> ReadAsync(InputFormatterContext context)

Parameters

context InputFormatterContext

The InputFormatterContext.

Returns

Task<InputFormatterResult>

A Task that on completion deserializes the request body.