swagger REST API 补丁请求更改模型的一个字段

Question

我设置了一个休息 API，其中包含以下项目作为模型的一部分。它是一种卡模型，用于处理公司员工的付款方式。 我正在尝试在卡控制器上创建一个补丁请求，我可以在其中更新卡的余额。我有一个 put 方法，但我不想每次都更新完整的对象，而我只想用补丁请求更新模型的 balance 字段。

public class Card
{
    [Key]
    public long CardNumber { get; set; }

    public decimal Balance { get; set; }

    public string PinNum { get; set; }

    public string CardId { get; set; }

    public long EmployeeId { get; set; }

}

put 方法适用于更新模型中的所有字段，但我的目标只是更新余额。我正在使用 swagger 端点来查看更改是否有效，并且在 PATCH 请求的 swagger 端点中，我希望它仅显示 JSON 中的 balance 字段并能够使用补丁更改更新数据库。

仅处理余额更新的最佳方式是什么，它是一个 PATCH 请求吗？如果是，它将如何实现？

Answer 1

您是否还需要卡号才能知道要更新哪些卡的余额？除非您使用我认为的 ID 进行路由。

您应该为天平创建一个 DTO。基本上，您创建了一个名为“CardBalanceDto”的类，它将仅包含您需要从 Card 模型中获得的字段（在本例中仅包含 balance 属性）。然后，在 PATCH 请求的 API 控制器方法上，只需接受 CardBalanceDto 类型，然后只更改余额字段。

[HttpPatch("{id}")]
public async Task<IActionResult> PatchCard(long id, CardBalanceDto balanceDto)
{
    var card = new Card() { Id = id, Balance = balanceDto.Balance};
    _context.Cards.Attach(Card);
    _context.Entry(card).Property(x => x.Balance).IsModified = true;
    return Ok(await _context.SaveChangesAsync());
}

你的 DTO 看起来像这样：

public class CardBalanceDto {
    public decimal Balance { get; set; }
}