How to Include Links when Serializing?

[falestra]

I'm building an API with ASP.NET Core 3.1, with an example model like this:

public class Article
{
    public string Id { get; set; }
    public string Title { get; set; }
    public List<Comment> Comments { get; set; }
}

public class Comment
{
    public string Id { get; set; }
    public string Body { get; set; }
}

The controller contains something like this:

var articles = await articleService.GetAsync(); // Get All Articles
return Json(articles, new JsonApiSerializerSettings());

How do I get the response from the controller to have Links?

[achobanov]

Need the same thing as well. Also the Meta object. Seems a bit strange how you seem to be able to configure those only for Deserialization, but not Serialization.

[achobanov]

Seems a bit strange how you seem to be able to configure those only for Deserialization,

Indeed it is strange, but fortunately it is not true. The library supports it very well, it's just not documented in the README.md. After brief skimming through the source you can find classes for both:

• Links
• Meta

To include them in root of the response you can use the DocumentRoot<T> class:

var meta = new Meta();
// populate
var links = new Links();
// populate

var response = new DocumentRoot<IList<T>>
{
    Data = resources // the list of resources.
    Links = links,
    Meta = meta,
};