如何通过restful api

时间:2018-09-07 03:39:08

标签: c# json restful-url

现在,我有一个用户对象,该对象具有三个必需的属性: {名字,  姓,  创建时间 }。

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

我应该传递Jason数据,其中包含我要发布的数据。

如果我传入{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(更新用户方法)。

谢谢。

2 个答案:

答案 0 :(得分:2)

1)插入记录时,只需将CreatedAtModifiedAt属性标记为[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

尝试一次可能对您有帮助

答案 1 :(得分:0)

这取决于您的属性数据类型,如果它们可以为空,那么您可以在发送消息中将它们保留为空或为空,但是如果它们不为空,则必须提供值,否则您将注意到目的地(您的wep- api操作)。 因此,现在,即使您不想为非空属性传递值,也可以在属性上使用[JsonIgnore]属性(属于Newtonsoft.Json)。像这样:

using Newtonsoft.Json;

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