net core web api json serialization - need fields prefixed with $

Question

I'm using net core web api and need to return a payload with property name "$skip". I tried using the DataAnnotations:

public class ApiResponseMessage
{
    [Display(Name ="$skip", ShortName = "$skip")]
    public int Skip { get; set; }
    [Display(Name = "$top", ShortName = "$top")]
    public int Top { get; set; }
}

In my Controller I simply use

return Json(payload)

However, my response payload looks like follow:

"ResponseMsg": {
    "Skip": 0,
    "Top": 3
}

and I need it to be:

"ResponseMsg": {
    "$skip": 0,
    "$top": 3
}

What is the best option to address this? Do I need to write my own ContractResolver or Converter?

Jhonatas Kleinkauff · Accepted Answer · 2019-06-25 23:52:48Z

17

starting in .net core 3.0 the framework now uses System.Text.Json. You can decorate a json attribute in your class with

[JsonPropertyName("htmlid")]
public string HtmlId { get; set; }

See System.Text.Json

answered Jun 25, 2019 at 23:52

Jhonatas Kleinkauff

9667 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Bhagyesh Patel · Accepted Answer · 2017-06-27 17:38:54Z

6

ASP.NET Core already uses JSON.NET as its base JavaScriptSerializer.

Here is the dependency.

Microsoft.AspNetCore.Mvc --> Microsoft.AspNetCore.Formatter.Json --> Microsoft.AspNetCore.JsonPatch --> Newtonsoft.Json

A sample decoration of the object like this would achieve the goal

[JsonObject]
public class ApiResponseMessage
{
    [JsonProperty("$skip")]
    public int Skip { get; set; }
    [JsonProperty("$top")]
    public int Top { get; set; }

    ....
}

answered Jun 27, 2017 at 17:38

Bhagyesh Patel

1712 bronze badges

1 Comment

Luc C Over a year ago

Thank you for showing that dependency path; that was what enabled to find what version of Newtonsoft.Json is actually in use (10.0.1 for my current setup)

Ilya Chumakov · Accepted Answer · 2017-06-27 17:18:24Z

3

Use JsonProperty attribute to set a custom property name:

[JsonProperty(PropertyName = "$skip")]
public int Skip { get; set; }

Output:

{ "$skip": 1 }

More info: How can I change property names when serializing with Json.net?

answered Jun 27, 2017 at 17:18

Ilya Chumakov

25.4k10 gold badges99 silver badges124 bronze badges

Collectives™ on Stack Overflow

net core web api json serialization - need fields prefixed with $

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related