Return a JSON string explicitly from Asp.net WEBAPI?

Question

In some cases I have NewtonSoft JSON.NET and in my controller I just return the JObject from my controller and all is good.

But I have a case where I get some raw JSON from another service and need to return it directly from my webAPI. In this context I can't use NewtonSoft, but if I could then I'd create a JObject from the string (which seems like unneeded processing overhead) and return that and all would be well with the world.

However, I want to return this simply, but if I return the string, then the client receives a JSON wrapper with my context as an encoded string.

How can I explicitly return a JSON from my WebAPI controller method?

Answer 1

There are a few alternatives. The simplest one is to have your method return a HttpResponseMessage, and create that response with a StringContent based on your string, something similar to the code below:

public HttpResponseMessage Get()
{
    string yourJson = GetJsonFromSomewhere();
    var response = this.Request.CreateResponse(HttpStatusCode.OK);
    response.Content = new StringContent(yourJson, Encoding.UTF8, "application/json");
    return response;
}

And checking null or empty JSON string

public HttpResponseMessage Get()
{
    string yourJson = GetJsonFromSomewhere();
    if (!string.IsNullOrEmpty(yourJson))
    {
        var response = this.Request.CreateResponse(HttpStatusCode.OK);
        response.Content = new StringContent(yourJson, Encoding.UTF8, "application/json");
        return response;
    }
    throw new HttpResponseException(HttpStatusCode.NotFound);
}

Answer 2

Here is @carlosfigueira's solution adapted to use the IHttpActionResult Interface that was introduced with WebApi2:

public IHttpActionResult Get()
{
    string yourJson = GetJsonFromSomewhere();
    if (string.IsNullOrEmpty(yourJson)){
        return NotFound();
    }
    var response = this.Request.CreateResponse(HttpStatusCode.OK);
    response.Content = new StringContent(yourJson, Encoding.UTF8, "application/json");
    return ResponseMessage(response);
}

Answer 3

This works for me in .NET Core 3.1.

private async Task<ContentResult> ChannelCosmicRaysAsync(HttpRequestMessage request)
{
    // client is HttpClient
    using var response = await client.SendAsync(request).ConfigureAwait(false); 

    var responseContentString = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

    Response.StatusCode = (int)response.StatusCode;
    return Content(responseContentString, "application/json");
}

public Task<ContentResult> X()
{
    var request = new HttpRequestMessage(HttpMethod.Post, url);
    (...)

    return ChannelCosmicRaysAsync(request);
}

ContentResult is Microsoft.AspNetCore.Mvc.ContentResult.

Please note this doesn't channel headers, but in my case this is what I need.

Answer 4

sample example to return json data from web api GET method

[HttpGet]
public IActionResult Get()
{
            return Content("{\"firstName\": \"John\",  \"lastName\": \"Doe\", \"lastUpdateTimeStamp\": \"2018-07-30T18:25:43.511Z\",  \"nextUpdateTimeStamp\": \"2018-08-30T18:25:43.511Z\");
}

Answer 5

If you specifically want to return that JSON only, without using WebAPI features (like allowing XML), you can always write directly to the output. Assuming you're hosting this with ASP.NET, you have access to the Response object, so you can write it out that way as a string, then you don't need to actually return anything from your method - you've already written the response text to the output stream.

Answer 6

I know Your question was about a Web Api Controller Method.

For others help below the solution for an Azure Function (InProcess, v4):

namespace FunctionApp1
{
    public static class Function1
    {
        [FunctionName("Function1")]
        public static  async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req,
            ILogger log)
        {
            //simulate data returned from external api
            var jsonString = "{\"name\":\"jack\", \"age\":10}";

            // return as ContentResult instead of JsonResult because when returning JsonResult
            // the middleware is escaping the jsonString (adding a '\' before every '"')
            var contentResult = new ContentResult();
            contentResult.Content = jsonString;
            contentResult.ContentType = "application/json";
            return contentResult;

        }
    }
}

Answer 7

If your controller method returns an IActionResult you can achieve this by manually setting the output formatter.

// Alternatively, if inheriting from ControllerBase you could do
// var result = Ok(jsonAsString);
var result = new OkObjectResult(jsonAsString);

var formatter = new StringOutputFormatter();
result.Formatters.Add(formatter);

formatter.SupportedMediaTypes.Clear();
formatter.SupportedMediaTypes.Add("application/json");

Answer 8

By default Web API returns JSON return data type It does return xml also and some custom media type formatters too if needed

you can disable the xmlformatter - this way if no custom media type formatter is given then only json will be returned

In the App_Start>> WebAPIconfig.cs --> Register Method config.Formatters.Remove(config.Formatters.XmlFormatter);

Hope this helps!

Answer 9

these also work:

[HttpGet]
[Route("RequestXXX")]
public ActionResult RequestXXX()
{
    string error = "";
    try{
        _session.RequestXXX();
    }
    catch(Exception e)
    {
        error = e.Message;
    }
    return new JsonResult(new { error=error, explanation="An error happened"});
}

[HttpGet]
[Route("RequestXXX")]
public ActionResult RequestXXX()
{
    string error = "";
    try{
        _session.RequestXXX();
    }
    catch(Exception e)
    {
        error = e.Message;
    }
    return new JsonResult(error);
}