将查询和标头参数绑定到同一个模型

Question

我正在尝试将 Query 和 Header 参数从 Controller 操作绑定到一个模型：

请求模型：

public class MyRequest
{
    [FromQuery]
    public string QueryParameter { get; set; }

    [FromHeader]
    public string HeaderParameter { get; set; }
}

控制器动作：

[HttpGet]
public ActionResult<MyResponse> FooAction(MyRequest myRequest)
{
    ...
}

问题在于：

1. Swagger 请求输入 json：

{
   "QueryParameter": "string",
   "HeaderParameter": "string"
}

1. 即使我尝试curl 这个端点，我也会得到“不支持的媒体类型”。

但是，如果我只是在控制器的操作中添加 [FromQuery]：

public ActionResult<MyResponse> FooAction([FromQuery] MyRequest myRequest)

然后它按预期工作。问题在于 - 不太清楚：“如果您有 FromHeader 字段，为什么要添加 FromQuery？”

我可以制作两个单独的模型，一个用于查询参数，另一个用于标头参数，但我真的很想找到一种方法将它们都放入同一个模型中。

Answer 1

我建议您阅读Model Binding，或直接转到Sources 部分。

这里是关于模型绑定源的总结：

默认情况下，模型绑定从 HTTP 请求中的以下来源以键值对的形式获取数据：表单字段、请求正文（对于 ApiControllers)、路由数据、查询字符串参数和上传的文件。

如果默认来源不正确，请使用以下属性之一指定来源：[FromQuery]、[FromRoute]、[FromFrom]、[FromBody] 和 [FromHeader]。 重要提示：这些属性被单独添加到模型属性中（而不是添加到模型类中）。

那么下面的代码将为你工作：

public IActionResult FooAction(MyRequest myRequest)
{
    return new JsonResult(myRequest);
}

public class MyRequest
{
    public string QueryParameter { get; set; }

    [FromHeader]
    public string HeaderParameter { get; set; }
}

Answer 2

首先，如果要将数据绑定到HttpGet中的对象，必须使用[FromQuery]，否则不会绑定到对象。如果数据是string myRequest而不是MyRequest myRequest .您不需要添加“[FromQuery]”。

另外，如果你使用HttpPost，它也不需要'[FromQuery]'：

控制器：

[HttpPost("FooAction")]
        public ActionResult FooAction(MyRequest myRequest)
        {
            return Ok();
        }

结果：