如何通过restful api传递部分对象（json）

Question

现在，我有一个用户对象，它有三个必需的属性：{FirstName，LastName，CreatedTime}。

现在我开发了一个API来创建用户。我想使用POST / api / users。

我应该传入Json数据，它包含我想发布的数据。

如果我传入{FirstName = abc，LastName = abc，CreatedTime = sometime}，它可以工作，但如果我错过了任何属性，比如只传入{firstname = abc}，它将抛出异常。

我粘贴了下面的方法。

    [Route("api/users")]
    public User CreateUser(User user)
    {
        if (!ModelState.IsValid)
            throw  new HttpResponseException(HttpStatusCode.BadRequest);

        user.FirstName = String.IsNullOrEmpty(user.FirstName) ? "Undefined" : user.FirstName;
        user.LastName = String.IsNullOrEmpty(user.LastName) ? "Undefined" : user.LastName;
        user.UserName = String.IsNullOrEmpty(user.UserName) ? "Undefined" : user.UserName;
        user.ModifiedAt = DateTime.Now;
        user.CreatedAt = DateTime.Now;
        _context.Users.Add(user);
        _context.SaveChanges();

        return user;
    }

我的问题是：有什么办法可以传递用户的部分属性吗？比如{firstname = abc}。

该技术也可以用作PUT（更新用户方法）。

提前致谢。

Answer 1

1）插入记录时，只需将CreatedAt和ModifiedAt属性标记为[JsonIgnore]属性

[Required] 
[JsonIgnore] 
public DateTime CreatedAt { get; set; } 

[Required] 
[JsonIgnore] 
public DateTime ModifiedAt { get; set; } 

2）当您尝试获取数据时，您的api方法将是

[HttpGet]
[Route("ById/{id=id}")]
public IHttpActionResult GetUser(int? id)
{
    if (id == null)
        return NotFound();

    User user = _context.Users.SingleOrDefault(c => c.UserId == id.Value);

    if (user == null)
        return BadRequest("User not exist in our database");

    var returnedData = new { FirstName = user.FirstName, LastName = user.LastName, UserName = user.UserName, CreatedAt = DateTime.Now, ModifiedAt = DateTime.Now };
    return Ok(returnedData);
}

我们只是用来返回可自定义的Anonymous Type来返回数据。

尝试一次它可以帮助你

Answer 2

这取决于你的属性数据类型，如果它们可以为空，那么你可以在发送消息中将它们留空或为null但如果它们不可为空，你必须提供值，否则你会在目的地中注意到（你的wep-api动作） 。因此，如果您想要避免传递值，即使对于非可空属性，您也可以在属性上使用[JsonIgnore]属性（属于Newtonsoft.Json）。像这样：

using Newtonsoft.Json;

public class User
{
   //...
   [JsonIgnore]
   public DateTime CreatedAt  { get; set; }
   //...
}