Return "raw" json in ASP.NET Core 2.0 Web Api

Question

The standard way AFAIK to return data in ASP.NET Core Web Api is by using IActionResult and providing e.g. an OkObject result. This works fine with objects, but what if I have obtained a JSON string somehow, and I just want to return that JSON back to the caller?

e.g.

public IActionResult GetSomeJSON()
{
    return Ok("{ \"name\":\"John\", \"age\":31, \"city\":\"New York\" }");
}

What ASP.NET Core does here is, it takes the JSON String, and wraps it into JSON again (e.g. it escapes the JSON)

Returning plain text with [Produces("text/plain")] does work by providing the "RAW" content, but it also sets the content-type of the response to PLAIN instead of JSON. We use [Produces("application/json")] on our Controllers.

How can I return the JSON that I have as a normal JSON content-type without it being escaped?

Note: It doesn't matter how the JSON string was aquired, it could be from a 3rd party service, or there are some special serialization needs so that we want to do custom serialization instead of using the default JSON.NET serializer.

@NevilleNazerane JSON sent as the return value (body), so no params involved. — MichelZ
– MichelZ, Commented Jan 19, 2018 at 9:27

MichelZ · Accepted Answer · 2018-01-19 08:34:39Z

122

And of course a few minutes after posting the question I stumble upon a solution :)

Just return Content with the content type application/json...

return Content("{ \"name\":\"John\", \"age\":31, \"city\":\"New York\" }", "application/json");

answered Jan 19, 2018 at 8:34

MichelZ

4,4245 gold badges32 silver badges36 bronze badges

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

5 Comments

Nickolodeon Over a year ago

Better yet to return Json(your json goes here) as per learn.microsoft.com/en-us/aspnet/core/web-api/advanced/…

bab Over a year ago

This was hugely helpful - thank you! (If i return Json as per the above comment, then it returns it chunked which my client can't use.) Your solution of returning Content with a specification of application/json is what solved my problem.

MC9000 Over a year ago

How do you do this for DotNetCore 2.1 ? The "Content" method is not recognized - so I believe they've changed something since.

MichelZ Over a year ago

@MC9000 You need ASPNetCore 2.1. NetCore2.1 is not enough. Content is a function of Microsoft.AspNetCore.Mvc.ControllerBase

Pang Over a year ago

You may consider using MediaTypeNames.Application.Json instead of "application/json" (for .NET Core 2.1+).

Arash Motamedi · Accepted Answer · 2018-01-19 08:34:28Z

30

In your action, replace Ok() with the Content() method, which lets you set the content (raw content), content type, and status code of your response: https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.contentresult?view=aspnetcore-2.0

answered Jan 19, 2018 at 8:34

Arash Motamedi

10.8k7 gold badges38 silver badges44 bronze badges

3 Comments

James Woodall Over a year ago

This is great. I have a feeling that this changed between ASP.NET Core 2 and ASP.NET Core 1.

MC9000 Over a year ago

another day of hair pulling here too. Would love to see a working solution for DNCore 2.1!

MichelZ Over a year ago

@MC9000 You need ASPNetCore 2.1. NetCore2.1 is not enough. Content is a function of Microsoft.AspNetCore.Mvc.ControllerBase

Uwe Keim · Accepted Answer · 2021-01-28 18:29:03Z

4

This worked for me, where Json() did not:

return new JsonResult(json);

edited Jan 28, 2021 at 18:29

Uwe Keim

40.9k61 gold badges193 silver badges308 bronze badges

answered Dec 29, 2020 at 8:22

Oliver Bock

5,1355 gold badges46 silver badges65 bronze badges

2 Comments

maurocam Over a year ago

With the release of .NET Core 3.0 - as <TargetFramework>netcoreapp3.1</TargetFramework> - we can now use JsonResult as a cleaner solution, and it does not require any Nuget packages as it is part of the Microsoft.AspNetCore.App framework

Zar Shardan Over a year ago

in net6.0 This also escapes the string parameter, so does not really do what the OP wants.

Zar Shardan · Accepted Answer · 2024-05-05 09:36:02Z

0

this works for me:

return Content(json, MediaTypeNames.Application.Json);

answered May 5, 2024 at 9:36

Zar Shardan

6,0012 gold badges44 silver badges41 bronze badges

Collectives™ on Stack Overflow

Return "raw" json in ASP.NET Core 2.0 Web Api

4 Answers 4

5 Comments

3 Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

5 Comments

3 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related