从 Web 方法动态返回字段

Question

我有一个 WebAPI 服务，我希望允许用户指定他们希望返回的字段。例如，假设我有以下Person 类：

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string Email { get; set; }
}

调用/api/people/ 会为所有人返回所有三个字段。如何处理像/api/people?fields=FirstName,Email 这样的请求，只为所有人返回这两个字段？如果我可以将first_name 之类的内容映射到FirstName，则可以加分，但这不是必需的。

Answer 1

这是Dynamic Language Runtime 尤其是ExpandoObject 的工作，据此您只返回在运行时确定的所需属性：

public dynamic GetPerson()
{
    bool firstNameRequired = true; // TODO: Parse querystring
    bool lastNameRequired = false; // TODO: Parse querystring

    dynamic rtn = new ExpandoObject();

    if (firstNameRequired)
        rtn.first_name = "Steve";

    if (lastNameRequired)
        rtn.last_name = "Jobs";

    // ... and so on

    return rtn;
}

void Main()
{
    // Using the serializer of your choice:
    Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(GetPerson()));
}

输出：

{"first_name":"史蒂夫"}

我现在没有办法对其进行测试 [我在 vanilla Web API 上的生产中有类似的东西，具有大量可选字段]，但是通过 .NET Core 文档，Web 方法看起来会有所不同像这样，尽管没有硬编码值！：

[HttpGet()]
public IActionResult Get([FromQuery(Name = "fields")] string fields)
{
    var fieldsOptions = fields.Split(',');

    dynamic rtn = new ExpandoObject();

    if (fieldsOptions.Contains("FirstName"))
        rtn.first_name = "Steve";

    if (fieldsOptions.Contains("LastName"))
        rtn.last_name = "Jobs";

    if (fieldsOptions.Contains("Email"))
        rtn.email = "steve@apple.com";

    return new ObjectResult(rtn);
}

---

您需要引用System.Dynamic.Runtime 包。

Answer 2

您可以使用conditional serialization。您将只根据 fields 参数是否包含标识该字段的字符串来确定您的 ShouldSerialize 返回值。这适用于您想与该字段关联的任何字符串。如果您愿意，您甚至可以为每个字段接受多个字符串。

要将 fieldList 放入您想要序列化的对象（Person）中，您可以将它或包含它的东西（HttpRequest.Query 或一些自定义选项类）传递给构造函数。

public bool ShouldSerializeFirstName(){  
    return fieldList.Contains("FirstName");            
}