.NET Web API（非核心）- 在实体框架控制器中创建补丁操作

Question

我在带有 Angular 前端的 .NET Web API（非核心）项目中使用 Entity Framework。 目前，我能找到的唯一补丁实施示例是针对 ASP.Net Core 产品的 - 所以我首先想确认 patch 是否甚至可以用普通的 ASP.Net Web API（不是核心）。

我想在我的一些控制器中实现patch，但默认情况下，实体控制器似乎没有附带补丁操作的代码。相反，它带有GET、PUT、POST 和DELETE。我的实体控制器中需要什么代码才能使补丁请求有效？有没有办法在添加新的实体控制器时指定这一点，还是必须始终手动输入？

我的控制器：

using System;
using System.Collections.Generic;
using System.Data;
using System.Data.Entity;
using System.Data.Entity.Infrastructure;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using System.Web.Http.Description;
using api.Models;
using api.Models.my_model;
using System.Net.Mail;
using System.Configuration;

namespace api.Controllers.my_model
{
    public class myController : ApiController
    {
        private myCodeFirst db = new myCodeFirst();

        // GET: api/my
        public IQueryable<myTable> GetmyTable()
        {
            return db.myTable;
        }

        // GET: api/my/5
        [ResponseType(typeof(myTable))]
        public IHttpActionResult GetmyTable(int id)
        {
            myTable myTable = db.myTable.Find(id);
            if (myTable == null)
            {
                return NotFound();
            }

            return Ok(myTable);
        }

        // PUT: api/my/5
        [ResponseType(typeof(void))]
        public IHttpActionResult PutmyTable(int id, myTable myTable)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            if (id != myTable.ID)
            {
                return BadRequest();
            }

            db.Entry(myTable).State = EntityState.Modified;

            try
            {
                db.SaveChanges();
            }
            catch (DbUpdateConcurrencyException)
            {
                if (!myTableExists(id))
                {
                    return NotFound();
                }
                else
                {
                    throw;
                }
            }

            return StatusCode(HttpStatusCode.NoContent);
        }

        // POST: api/my
        [ResponseType(typeof(myTable))]
        public IHttpActionResult PostmyTable(myTable myTable)
        {

            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            db.myTable.Add(myTable);


            db.SaveChanges();


            return CreatedAtRoute("DefaultApi", new { id = myTable.ID }, myTable);
        }

        // DELETE: api/my/5
        [ResponseType(typeof(myTable))]
        public IHttpActionResult DeletemyTable(int id)
        {
            myTable myTable = db.myTable.Find(id);
            if (myTable == null)
            {
                return NotFound();
            }

            db.myTable.Remove(myTable);
            db.SaveChanges();

            return Ok(myTable);
        }

        protected override void Dispose(bool disposing)
        {
            if (disposing)
            {
                db.Dispose();
            }
            base.Dispose(disposing);
        }

        private bool myTableExists(int id)
        {
            return db.myTable.Count(e => e.ID == id) > 0;
        }


    }



}

Answer 1

PATCH 方法是 HTTP 协议支持的一种请求方法，用于对现有资源进行部分更改。 可以看到一些 JSON Patch 操作：

添加

{
    "op": "add",
    "path": "/a/b",
    "value": "foo"
}

删除

{
    "op": "remove",
    "path": "/a/b"
}

替换

{
    "op": "replace",
    "path": "/a/b",
    "value": "foo"
}

复制

{
    "op": "copy",
    "from": "/a/b",
    "path": "/a/c"
}

移动

{
    "op": "move",
    "from": "/a/b",
    "path": "/a/c"
}

测试

{
    "op": "test",
    "path": "/a/b",
    "value": "foo"
}

---

在 ASP.NET Core 中，您可以使用 [HttpPatch] 属性指定补丁方法。 要在此方法中获取数据，您应该使用 JsonPatchDocument<TModel> 存在于 Microsoft.ApsNetCore.JsonPatch 命名空间中，其中 TModel 是您要转换为它的实体。另一个有用的包是 AutoMapper。您可以从 NuGet 包管理器安装它，如下所示：

Install-Package AutoMapper

并在您的控制器中引用它。

现在是时候看一个 ASP.NET Core Web API 中的示例了：

public async Task<IActionResult> PartiallyUpdateBook([FromRoute] Guid id, [FromBody] JsonPatchDocument<BookModel> patchDoc)
{
    // If the received data is null
    if (patchDoc == null)
    {
        return BadRequest();
    }

    // Retrieve book from database
    var book = await _context.Books.SingleOrDefaultAsync(x => x.Id == id)

    // Check if is the book exist or not
    if (book == null)
    {
        return NotFound();
    }

    // Map retrieved book to BookModel with other properties (More or less with eexactly same name)
    var bookToPatch = Mapper.Map<BookModel>(book);

    // Apply book to ModelState
    patchDoc.ApplyTo(bookToPatch, ModelState);

    // Use this method to validate your data
    TryValidateModel(bookToPatch);

    // If model is not valid, return the problem
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    // Assign entity changes to original entity retrieved from database
    Mapper.Map(bookToPatch, book);

    // Say to entity framework that you have changes in book entity and it's modified
    _context.Entry(book).State = EntityState.Modified;

    // Save changes to database
    await _context.SaveChangesAsync();

    // If everything was ok, return no content status code to users
    return NoContent();
}