从Asp.net WEBAPI显式返回JSON字符串？

Question

在某些情况下,我有NewtonSoft JSON.NET,在我的控制器中,我只是从我的控制器返回Jobject,一切都很好.

但我有一个案例,我从另一个服务获得一些原始JSON,需要从我的webAPI返回它.在这种情况下,我不能使用NewtonSOft,但如果可以的话,我会从字符串创建一个JOBJECT(这似乎是不需要的处理开销)并返回,并且一切都将与世界相得益彰.

但是,我想简单地返回这个,但是如果我返回字符串,那么客户端会收到一个JSON包装器,我的上下文是一个编码字符串.

如何从WebAPI控制器方法中显式返回JSON？

Answer 1

还有一些选择.最简单的方法是让你的方法返回一个HttpResponseMessage,并StringContent根据你的字符串创建响应,类似于下面的代码:

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

并检查null或空JSON字符串

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

这在 .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是Microsoft.AspNetCore.Mvc.ContentResult。

请注意，这不是频道标题，但就我而言，这就是我所需要的。

Answer 3

这是@carlosfigueira的解决方案，适用于使用WebApi2引入的IHttpActionResult接口：

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 4

从 Web api GET 方法返回 json 数据的示例

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