How to change response json property names only for specific action in ASP.NET Core Web Api?

Question

I am using ASP.NET Core 3.1 Web API. I have the following response model:

public class UserModel
{
   public string UserId { get; set; }
   public string UserName { get; set; }
}

It produces the following json response:

{
    "userId": 1,
    "userName": "SomeName"
}

I am interested in is there any way to change the property names of output JSON without creating a new class? Also, I would like to apply this rule only for specific action and keep default property names for other actions. In our project, we stick to System.Text.Json Serializer. The desired JSON output:

{
    "teacherId": 1,
    "teacherName": "SomeName"
}

If the model contains only two properties, you could try anonymous type. — weichch
– weichch, Commented Oct 3, 2020 at 8:16
Create a TeacherModel - a teacher is more specific than a user, and so they represent different things. — John H
– John H, Commented Oct 3, 2020 at 8:44
Is it good practice to create a separate model for this if you just changing the names of properties? — Dastan Alybaev
– Dastan Alybaev, Commented Oct 3, 2020 at 18:56
If you ask yourself the question, "Should these two things be able to change independently?", and the answer is "yes", then yes, having two separate models is fine. — John H
– John H, Commented Oct 3, 2020 at 19:06

nkalfov · Accepted Answer · 2022-01-21 14:35:52Z

4

If you don't want to switch to Newtonsoft.JSON and use the default serializer, use [JsonPropertyName("name")]. You may find extensive information from Microsoft @ https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-customize-properties?pivots=dotnet-core-3-1

answered Jan 21, 2022 at 14:35

nkalfov

4596 silver badges14 bronze badges

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

Comments

Mustafa Arslan · Accepted Answer · 2020-10-03 09:37:56Z

0

You can use JsonResult class from Microsoft.AspNetCore.Mvc namespace on Action.

return new JsonResult(new
        {
            TeacherId = userModel.UserId,
            TeacherName = userModel.UserName
        });

answered Oct 3, 2020 at 9:37

Mustafa Arslan

7945 silver badges13 bronze badges

Comments

Mehdi Fattahzadeh · Accepted Answer · 2020-10-03 13:03:42Z

0

using Newtonsoft.Json;

public class UserModel
{
   [JsonProperty(PropertyName = "Foo")]
   public string UserId { get; set; }
   public string UserName { get; set; }
}

.net core 3.* doesn't work with Newtonsoft by default.

you should install Microsoft.AspNetCore.Mvc.NewtonsoftJson

and add it to your project

services.AddControllers().AddNewtonsoftJson();

answered Oct 3, 2020 at 13:03

Mehdi Fattahzadeh

615 bronze badges

2 Comments

John H Over a year ago

The question's title indicates the change is only wanted for a specific action - this would apply to all actions that use UserModel.

nkalfov Over a year ago

For core 3 and net 5 default serializer [JsonPropertyName("name")] should be used.

Collectives™ on Stack Overflow

How to change response json property names only for specific action in ASP.NET Core Web Api?

3 Answers 3

Comments

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related