在 Web API 中未检测到对象数组

Question

我正在使用 .NET Core 2.1 开发一个 Web API，其中响应是根据从 WCF 服务接收到的输出来操作的。

我需要一个带有 Get 动词的 API，并且需要将一个复杂对象数组作为输入传递给它。我目前面临的挑战是，没有从输入中检测到数组。我添加了 @987654321 @ 连同输入参数。我正在 Swagger UI 中尝试相同的操作。

尝试将 Name 与 FromQuery 一起添加。

[HttpGet("test")]
public IActionResult Testmethod([FromQuery] Person person)
{
    return Ok(person);
}

模型类：

public class Person
{
    public string Name{ get; set; }
    public int Age{ get; set; }
    public Grade[] grades{ get; set; }
}

public class Grade
{
    public int GradeId { get; set; }
    public string GradeName { get; set; }
    public string Section { get; set; }
}

Answer 1

对于这种情况，Swagger 生成的查询似乎有点错误。正确的查询是：

GET /test
  ?name=thomas
  &age=20
  &grade[0].gradeId=2
  &grade[0].gradeName=Second
  &grade[0].section=Section

外部资源

此问题已在此处记录：https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/1832

这里也讲过：OpenAPI query string parameter with list of objects

解决方案

这是 OpenAPI 的问题，我们无法解决。

这是最好的解决方案：

如果您正在设计新的 API（而不是描述现有的 API），请考虑在请求正文中传递对象数组。

https://stackoverflow.com/a/52894157

查询字符串格式因对象而异

这很不寻常，因为如果代码是这样的：

[HttpGet("test")]
public IActionResult Testmethod([FromQuery] SomeQuery query)
{
    // ...
}

public class SomeQuery
{
    public int[] Ids { get; set; }
}

我们的 API 调用如下所示：

GET /test
  ?ids=1
  &ids=2

但是，如果你有一个对象数组，那么 GET 请求的格式就会改变。

测试的版本

• Swashbuckle.AspNetCore 6.5.0
• .NET Framework net5.0

Answer 2

试试下面的

[FromBody] IEnumerable<Person> persons