在某些情况下，我有 NewtonSoft JSON.NET，在我的控制器中，我只是从控制器返回 Jobject，一切都很好。
但我有一个案例，我从另一个服务获取了一些原始 JSON，需要从我的 webAPI 返回它。在这种情况下，我不能使用 NewtonSOft，但如果可以的话，我会从字符串创建一个 JOBJECT（这似乎是不必要的处理开销）并返回它，一切都会好起来的。
但是，我想简单地返回它，但如果我返回字符串，那么客户端会收到一个 JSON 包装器，其中包含我的上下文作为编码字符串。
如何从我的 WebAPI 控制器方法显式返回 JSON？
【问题讨论】：
标签： asp.net-mvc json asp.net-web-api
如果您特别想只返回该 JSON，而不使用 WebAPI 功能（例如允许 XML），您始终可以直接写入输出。假设您使用 ASP.NET 托管它，您可以访问 Response 对象，因此您可以将其写为字符串，那么您实际上不需要从您的方法中返回任何内容 - 您已经已将响应文本写入输出流。
【讨论】：
有几种选择。最简单的方法是让您的方法返回 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);
}
【讨论】：
HttpResponseMessage response，然后将StringContent 分配给.Content 属性。如果在构造函数中分配 StringContent 则不起作用。
这是@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);
}
【讨论】：
从 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\");
}
【讨论】：
这些也有效：
[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);
}
【讨论】：
这适用于 .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。
请注意，这不是频道标题，但在我的情况下，这是我需要的。
【讨论】：
如果您的控制器方法返回 IActionResult，您可以通过手动设置输出格式化程序来实现。
// 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");
【讨论】：