如何为可能多次出现的属性（prop、prop2、prop3、...）实现 C# 模型类？

Question

我有一个 ASP.NET Core 2.1 API Web 服务。

应该使用可以使用以下请求的新 API 端点扩展 Web 服务（HTTP POST 正文是 www-form-urlencoded）：

foo=1&bar=2&baz=3&baz_2=3&baz_2=4

上面的 www-form-urlencoded 以一种更易读的方式：

• 参数foo，值为1。
• 参数bar，值为2。
• 参数baz，值为3。
• 参数baz_2，值为4。

参数foo 和bar 在请求中完全存在且仅存在1 次。参数baz 在请求中至少存在1 次。 baz 参数出现多次是很常见的，但我见过只有一个 baz 参数的情况。

我对发件人没有影响。我可以选择使用上述格式的请求，或者根本无法接收数据。我需要这些数据，这些数据只会以上述方式提供。

我已经为请求中仅存在 1 次的参数建模了一个 C# 模型类：

namespace StackOverflow.WebAPI.Models
{
    public class ConsumeRequest
    {
        public int foo { get; set; }
        public int bar { get; set; }

        public ConsumeRequest()
        {
            foo = 0;
            bar = 0;
        }

        public ConsumeRequest(int foo, int bar)
        {
            this.foo = foo;
            this.bar = bar;
        }
    }
}

模型应作为Action参数，如：

namespace StackOverflow.WebAPI
{
    public class EndpointController : BaseController
    {
        [HttpPost]
        public JsonResult Consume([FromBody] ConsumeRequest data)
        {
            // Do something with data.
            return new JsonResult("ok");
        }
    }
}

理想情况下，baz 将是 List<int>。 List 的顺序将代表bazs 的“顺序”（baz，baz_2，baz_3，...）。

如何扩展模型实现以使用 baz 参数？

Answer 1

这不是您希望绑定的有效请求格式。 baz_2 键字面意思是类似于Baz_2 属性，而不是Baz 集合中的第二项。为此，密钥必须类似于baz[]，根据需要重复多次。例如：

?baz[]=3&baz[]=4

这将创建一个值集合[3, 4]。

如果问题是您无法控制查询字符串的格式，那是 客户端 问题，而不是您的问题。 API 实际上是一个接口。它强制执行请求的特定形式和功能，不符合该接口是一个错误的请求。你永远不应该改变你的 API 来适应客户端；而是客户端需要更改其代码以符合您的 API。

也就是说，如果您在这里别无选择，您唯一能做的就是添加Baz_2 属性和Baz_3、Baz_4 等，根据需要添加。但是，总会有一些限制，因为这些必须是文字属性，您必须实际添加到您要绑定的类中。