ASP.NET MVC 对 WebAPI 接口操作（添加、更新和删除）详解

// Models/Product.cs
using System.ComponentModel.DataAnnotations;
 
namespace WebApiDemo.Models;
 
public class Product
{
    public int Id { get; set; }
 
    [Required(ErrorMessage = "商品名称不能为空")]
    [MaxLength(50, ErrorMessage = "商品名称长度不能超过 50 字符")]
    public string Name { get; set; } = string.Empty;
 
    [Range(0.01, double.MaxValue, ErrorMessage = "价格必须大于 0")]
    public decimal Price { get; set; }
 
    public DateTime CreateTime { get; set; } = DateTime.Now;
}

// Controllers/ProductsController.cs
using Microsoft.AspNetCore.Mvc;
using WebApiDemo.Models;
 
namespace WebApiDemo.Controllers;
 
[Route("api/[controller]")] // 路由模板：api/Products
[ApiController] // 自动启用模型验证、绑定等特性
public class ProductsController : ControllerBase
{
    // 模拟数据库（实际项目中替换为 EF Core 等 ORM）
    private static List<Product> _products = new()
    {
        new Product { Id = 1, Name = "笔记本电脑", Price = 5999.99m },
        new Product { Id = 2, Name = "无线鼠标", Price = 99.99m }
    };
 
    // 后续操作方法将在此添加
}

/// <summary>
/// 添加新商品
/// </summary>
/// <param name="product">商品信息</param>
/// <returns>创建的商品及位置</returns>
[HttpPost] // 标记为 POST 请求
public async Task<ActionResult<Product>> CreateProduct(Product product)
{
    // 模型验证（由 [ApiController] 自动触发，若验证失败返回 400 Bad Request）
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState); // 返回验证错误详情
    }
 
    try
    {
        // 模拟数据库操作（实际项目中使用 EF Core 的 AddAsync）
        product.Id = _products.Max(p => p.Id) + 1; // 生成新 ID
        product.CreateTime = DateTime.Now;
        _products.Add(product);
 
        // 模拟异步延迟（实际项目中替换为 await _context.SaveChangesAsync()）
        await Task.Delay(100);
 
        // 返回 201 Created，并包含新资源的 URL（符合 REST 最佳实践）
        return CreatedAtAction(nameof(GetProduct), new { id = product.Id }, product);
    }
    catch (Exception ex)
    {
        // 捕获异常并返回 500 错误详情
        return Problem($"添加商品失败：{ex.Message}");
    }
}
 
// 辅助方法：根据 ID 获取商品（用于 CreatedAtAction 生成 URL）
[HttpGet("{id}")]
public ActionResult<Product> GetProduct(int id)
{
    var product = _products.FirstOrDefault(p => p.Id == id);
    if (product == null)
    {
        return NotFound("商品不存在");
    }
    return product;
}

/// <summary>
/// 更新商品（全量更新）
/// </summary>
/// <param name="id">商品 ID</param>
/// <param name="product">更新后的商品信息</param>
/// <returns>无内容</returns>
[HttpPut("{id}")] // 路由参数：api/Products/{id}
public async Task<IActionResult> UpdateProduct(int id, Product product)
{
    // 验证 URL 中的 ID 与请求体中的 ID 是否一致
    if (id != product.Id)
    {
        return BadRequest("URL 中的 ID 与请求体中的 ID 不匹配");
    }
 
    // 查找商品
    var existingProduct = _products.FirstOrDefault(p => p.Id == id);
    if (existingProduct == null)
    {
        return NotFound($"ID 为 {id} 的商品不存在");
    }
 
    // 模型验证
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
 
    try
    {
        // 更新字段（实际项目中使用 EF Core 的 Update 方法）
        existingProduct.Name = product.Name;
        existingProduct.Price = product.Price;
        // CreateTime 通常不允许更新，故不修改
 
        // 模拟异步保存（实际项目中使用 await _context.SaveChangesAsync()）
        await Task.Delay(100);
 
        // 返回 204 No Content（表示更新成功且无返回内容）
        return NoContent();
    }
    catch (Exception ex)
    {
        return Problem($"更新商品失败：{ex.Message}");
    }
}

/// <summary>
/// 删除商品
/// </summary>
/// <param name="id">商品 ID</param>
/// <returns>无内容</returns>
[HttpDelete("{id}")] // 路由参数：api/Products/{id}
public async Task<IActionResult> DeleteProduct(int id)
{
    // 查找商品
    var product = _products.FirstOrDefault(p => p.Id == id);
    if (product == null)
    {
        return NotFound($"ID 为 {id} 的商品不存在");
    }
 
    try
    {
        // 删除商品（实际项目中使用 EF Core 的 Remove 方法）
        _products.Remove(product);
 
        // 模拟异步保存
        await Task.Delay(100);
 
        return NoContent(); // 204 表示删除成功
    }
    catch (Exception ex)
    {
        return Problem($"删除商品失败：{ex.Message}");
    }
}