IActionResult 向 json 文本添加了不必要的部分

Question

我正在尝试从 API 返回 json object。 它理论上可行，但有些东西将我的数据包装到不必要的“对象”中，包括格式化程序、内容类型、声明类型、状态代码：

{
  "value": [
    {
      "id": 2,
      "text": "foo",
      "values": [
        {
          "pointName": "bar",
          "value": 1
        }
      ]
    }
  ],
  "formatters": [],
  "contentTypes": [],
  "declaredType": null,
  "statusCode": 200
}

当我除了只有

[
    {
      "id": 2,
      "text": "foo",
      "values": [
        {
          "pointName": "bar",
          "value": 1
        }
      ]
    }
  ]

当我需要返回一些错误代码（如禁止或错误请求）时，就会出现此问题。 我将返回 object 类型从 IEnumerable<ListObject> 更改为 IActionResult。 我的代码是下一个：

public class ListObject
{
    public int ID { get; set; }
    public string Text { get; set; }
    public List<ObjectValue> values { get; set; }
}
public class ObjectValue
{
    public string pointName { get; set; }
    public double value { get; set; }
}

[HttpPost]
[Route("getPointDataList/{deviceName}")]
[ProducesResponseType(typeof(IEnumerable<ListObject>),StatusCodes.Status200OK)]
public IActionResult getPointDataList(string deviceName, [FromBody] string[] points)
{
    
    try
    {
        if (points == null || points.Length == 0)
            return BadRequest("No points defined on request");
        return getPointDataListInternal(deviceName, points);  //This function return type is IActionResult, and it returns Ok(ListObject)
    } catch (Exception ex)
    {
        return BadRequest(ex.Message);
    }            
}

是否有任何简单/合理的方法来摆脱这种不必要的退货 object？ 我在.Net Core 3.1 中使用 C#。

Answer 1

它们不是不必要的值，它们是IActionResult的一部分，或者更具体地说是IActionResult实现的ObjectResult的一部分。 因此，通过将返回类型更改为IActionResult ，您还可以返回这些属性。

例如，StatusCode 是为了告诉您请求是如何进行的。 比如200 Ok ， 400 BadRequest等等。 因此，当您在代码中返回BadRequest("No points defined on request"); StatusCode 是 400。任何一种 http 请求都有一个状态码，无论是用于网页，API 请求等。

您可以在此处阅读有关ObjectResult不同属性的更多信息： https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.objectresult?view=aspnetcore-6.0

Answer 2

回答我自己的帖子。 问题不在我的帖子中。 奇怪行为的原因是我两次返回 Ok。 （好的（好的（数据））。

删除第二个确定确实解决了我的问题。

[HttpPost]
[Route("getPointDataList/{deviceName}")]
[ProducesResponseType(typeof(IEnumerable<ListObject>),StatusCodes.Status200OK)]
public IActionResult getPointDataList(string deviceName, [FromBody] string[] points)
{
    
    try
    {
        if (points == null || points.Length == 0)
            return BadRequest("No points defined on request");
        return getPointDataListInternal(deviceName, points);  //This function return type is IActionResult, and it returns Ok(ListObject)
    } catch (Exception ex)
    {
        return BadRequest(ex.Message);
    }            
}
protected IActionResult getPointDataListInternal(string deviceName, string[] points)
{
    return Ok(getPointDataListInternal(deviceName, points, null);  //<-Nested Ok here! Removing Ok() from here did solve the problem.
}

protected IActionResult getPointDataListInternal(string deviceName, string[] points, object xxx)
{
    //code
    return Ok(returnvalue);
}