Swagger UI将绑定到单个操作参数的多个标头作为单个json对象发送，而不是作为多个标头发送

如何解决Swagger UI将绑定到单个操作参数的多个标头作为单个json对象发送，而不是作为多个标头发送

我通过遵循通常的MS文档在asp.net core 3.1 API中启用了Swagger。 https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio 很好。

以下控制器在Postman中运行良好。 myBody 具有从POST请求的json正文绑定的 Body1 和 Body2 字段。 myHeader 具有与请求的两个“ Header1”和“ Header2”标头绑定的 Header1 和 Header2 。

namespace MyApi.Controllers
{
    [ApiController]
    [Route("test")]
    public class TestController : ControllerBase
    {
        [HttpPost]
        [ProducesResponseType(StatusCodes.Status200OK)]
        public ActionResult Post(
            [FromHeader] MyHeaders myHeaders,MyBody myBody)
        {
            return Ok();
        }
    }

    public class MyHeaders
    {
        [FromHeader]
        public string Header1 { get; set; }

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

    public class MyBody
    {
        public string Body1 { get; set; }

        public string Body2 { get; set; }
    }
}

但是Swagger UI仅为两个标头传递1个json对象： [swagger ui] [1]

并生成相应的curl命令： curl -X POST "https://localhost:5001/test" -H "accept: */*" -H "myHeaders: header1,string,header2,string" -H "Content-Type: application/json" -d "{\"body1\":\"string\",\"body2\":\"string\"}"

问题是 -H“ myHeaders：header1，string，header2，string” 部分。模型绑定按预期将myHeaders.Header1和.Header2设置为null，因为标题被命名为“ myHeaders”。用** -H“ Header1：cat” -H“ Header2：dog”替换该部分。

Asp.net足够聪明，可以通过匹配它们的名称将单独的标头映射到单个操作参数中。但是，如何让Swagger的UI具有多个标头，所以它的curl命令起作用呢？我知道我可以将[FromHeader] MyHeaders myHeaders替换为[FromHeader] string Header1,[FromHeader] string Header2，但是我想避免这种情况。将有数十个动作都接收相同的标头集。

解决方法

Yura在How to use [FromHeader] attribute with custom model binding in Asp.Net Core 2.2中的回答给出了解决方案它将 [FromHeader] MyHeaders myHeaders 更改为 [FromQuery] MyHeaders myHeaders 。即使FromQuery似乎与Header1和Header2的FromHeader属性相矛盾，这也可以使Swagger UI正常工作。

固定代码为：

public class TestController : ControllerBase
{
    [HttpPost]
    [ProducesResponseType(StatusCodes.Status200OK)]
    public ActionResult Post(
        [FromQuery] MyHeaders myHeaders,// FromHeader is changed to FromQuery
        MyBody myBody)
    {
        return Ok();
    }
}

public class MyHeaders // unchanged
{
    [FromHeader]
    public string Header1 { get; set; }

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