{"id":246,"date":"2023-10-15T15:36:38","date_gmt":"2023-10-15T07:36:38","guid":{"rendered":"https:\/\/miie.net\/?p=246"},"modified":"2023-10-15T15:36:38","modified_gmt":"2023-10-15T07:36:38","slug":"ultimate-asp-net-core-web-api-chapter12-working-with-patch-requests","status":"publish","type":"post","link":"https:\/\/diji.net\/?p=246","title":{"rendered":"Chapter12:WORKING WITH PATCH REQUESTS"},"content":{"rendered":"

12 WORKING WITH PATCH REQUESTS<\/h1>\n

In the previous chapter, we worked with the PUT request to fully update our resource. But if we want to update our resource only partially, we should use PATCH.
\n\u5728\u4e0a\u4e00\u7ae0\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528 PUT \u8bf7\u6c42\u6765\u5b8c\u5168\u66f4\u65b0\u6211\u4eec\u7684\u8d44\u6e90\u3002\u4f46\u662f\uff0c\u5982\u679c\u6211\u4eec\u53ea\u60f3\u90e8\u5206\u66f4\u65b0\u6211\u4eec\u7684\u8d44\u6e90\uff0c\u6211\u4eec\u5e94\u8be5\u4f7f\u7528 PATCH\u3002<\/p>\n<\/p>\n

The partial update isn\u2019t the only difference between PATCH and PUT. The request body is different as well. For the Company PATCH request, for example, we should use [FromBody]JsonPatchDocument<\/strong> and not [FromBody]Company<\/strong> as we did with the PUT requests.
\n\u90e8\u5206\u66f4\u65b0\u5e76\u4e0d\u662fPATCH\u548cPUT\u4e4b\u95f4\u7684\u552f\u4e00\u533a\u522b\u3002\u8bf7\u6c42\u6b63\u6587\u4e5f\u4e0d\u540c\u3002\u4f8b\u5982\uff0c\u5bf9\u4e8e\u516c\u53f8\u8865\u4e01\u8bf7\u6c42\uff0c\u6211\u4eec\u5e94\u8be5\u4f7f\u7528 [FromBody]JsonPatchDocument\u800c\u4e0d\u662f\u50cf\u5904\u7406 PUT \u8bf7\u6c42\u90a3\u6837\u4f7f\u7528 [FromBody]Company\u3002<\/p>\n

Additionally, for the PUT request\u2019s media type, we have used application\/json<\/strong> \u2014 but for the PATCH request\u2019s media type, we should use application\/json-patch+json<\/strong>. Even though the first one would be accepted in ASP.NET Core for the PATCH request, the recommendation by REST standards is to use the second one.
\n\u6b64\u5916\uff0c\u5bf9\u4e8e PUT \u8bf7\u6c42\u7684\u5a92\u4f53\u7c7b\u578b\uff0c\u6211\u4eec\u4f7f\u7528\u4e86 application\/json \u2014 \u4f46\u5bf9\u4e8e PATCH \u8bf7\u6c42\u7684\u5a92\u4f53\u7c7b\u578b\uff0c\u6211\u4eec\u5e94\u8be5\u4f7f\u7528 application\/json-patch+json\u3002 \u5c3d\u7ba1\u7b2c\u4e00\u4e2a ASP.NET Core\u4f1a\u63a5\u53d7\u7528\u4e8ePATCH\u8bf7\u6c42\uff0c\u4f46REST\u6807\u51c6\u7684\u5efa\u8bae\u662f\u4f7f\u7528\u7b2c\u4e8c\u4e2a\u3002<\/p>\n

Let\u2019s see what the PATCH request body looks like:
\n\u8ba9\u6211\u4eec\u770b\u770b PATCH \u8bf7\u6c42\u6b63\u6587\u662f\u4ec0\u4e48\u6837\u5b50\u7684\uff1a<\/p>\n

\n\n[ \n    {\n         "op": "replace",\n         "path": "\/name", \n        "value": "new name" \n    }, \n    { \n        "op": "remove", \n        "path": "\/name" \n    } \n]\n\n<\/pre>\n<\/p>\n
The square brackets represent an array of operations. Every operation is placed between curly brackets. So, in this specific example, we have two operations: Replace and Remove represented by the op property. The path property represents the object\u2019s property that we want to modify and the value property represents a new value.
\n\u65b9\u62ec\u53f7\u8868\u793a\u64cd\u4f5c\u6570\u7ec4\u3002\u6bcf\u4e2a\u64cd\u4f5c\u90fd\u653e\u5728\u5927\u62ec\u53f7\u4e4b\u95f4\u3002\u56e0\u6b64\uff0c\u5728\u8fd9\u4e2a\u7279\u5b9a\u793a\u4f8b\u4e2d\uff0c\u6211\u4eec\u6709\u4e24\u4e2a\u64cd\u4f5c\uff1a\u66ff\u6362\u548c\u5220\u9664\u7531 op \u5c5e\u6027\u8868\u793a\u3002path \u5c5e\u6027\u8868\u793a\u6211\u4eec\u8981\u4fee\u6539\u7684\u5bf9\u8c61\u5c5e\u6027\uff0cvalue \u5c5e\u6027\u8868\u793a\u65b0\u503c\u3002<\/p>\n
In this specific example, for the first operation, we replace the value of the name property to a new name. In the second example, we remove the name property, thus setting its value to default.
\n\u5728\u6b64\u7279\u5b9a\u793a\u4f8b\u4e2d\uff0c\u5bf9\u4e8e\u7b2c\u4e00\u4e2a\u64cd\u4f5c\uff0c\u6211\u4eec\u5c06 name \u5c5e\u6027\u7684\u503c\u66ff\u6362\u4e3a\u65b0\u540d\u79f0\u3002\u5728\u7b2c\u4e8c\u4e2a\u793a\u4f8b\u4e2d\uff0c\u6211\u4eec\u5220\u9664 name \u5c5e\u6027\uff0c\u4ece\u800c\u5c06\u5176\u503c\u8bbe\u7f6e\u4e3a\u9ed8\u8ba4\u503c\u3002<\/p>\n
There are six different operations for a PATCH request:
\n\u5bf9\u4e8e PATCH \u8bf7\u6c42\uff0c\u6709\u516d\u79cd\u4e0d\u540c\u7684\u64cd\u4f5c\uff1a<\/p>\n\n\n\n\n\n\n\n\n
\nOPERATION\n<\/th>\n\nREQUEST BODY\n<\/th>\n\nEXPLANATION\n<\/th>\n<\/tr>\n
\nAdd\n<\/td>\n\n{
\n    \"op\": \"add\",
\n    \"path\": \"\/name\",
\n    \"value\": \"new value\"
\n}\n<\/td>\n		\nAssigns a new value to a required property.
\n\u4e3a\u5fc5\u9700\u5c5e\u6027\u5206\u914d\u65b0\u503c\u3002\n<\/td>\n<\/tr>\n
\nRemove\n<\/td>\n\n{
\n    \"op\": \"remove\",
\n    \"path\": \"\/name\"
\n}\n<\/td>\n		\nSets a default value to a required property.
\n\u5c06\u9ed8\u8ba4\u503c\u8bbe\u7f6e\u4e3a\u5fc5\u9700\u5c5e\u6027\n<\/td>\n<\/tr>\n
\nReplace\n<\/td>\n\n{
\n    \"op\": \"replace\",
\n    \"path\": \"\/name\",
\n    \"value\": \"new value\"
\n}\n<\/td>\n		\nReplaces a value of a required property to a new value.
\n\u5c06\u5fc5\u9700\u5c5e\u6027\u7684\u503c\u66ff\u6362\u4e3a\u65b0\u503c\u3002\n<\/td>\n<\/tr>\n
\nCopy\n<\/td>\n\n{
\n    \"op\": \"copy\",
\n    \"from\": \"\/name\",
\n    \"path\": \"\/title\"
\n}\n<\/td>\n		\nCopies the value from a property in the \u201cfrom\u201d part to the property in the \u201cpath\u201d part.
\n\u5c06\u503c\u4ece\u201cfrom\u201d\u90e8\u5206\u4e2d\u7684\u5c5e\u6027\u590d\u5236\u5230\u201cpath\u201d\u90e8\u5206\u4e2d\u7684\u5c5e\u6027\u3002\n<\/td>\n<\/tr>\n
\nMove\n<\/td>\n\n{
\n    \"op\": \"move\",
\n    \"from\": \"\/name\",
\n    \"path\": \"\/title\"
\n}\n<\/td>\n		\nMoves the value from a property in the \u201cfrom\u201d part to a property in the \u201cpath\u201d part.
\n\u5c06\u503c\u4ece\u201cfrom\u201d\u90e8\u5206\u4e2d\u7684\u5c5e\u6027\u79fb\u52a8\u5230\u201cpath\u201d\u90e8\u5206\u4e2d\u7684\u5c5e\u6027\u3002\n<\/td>\n<\/tr>\n
\nTest\n<\/td>\n\n{
\n    \"op\": \"test\",
\n    \"path\": \"\/name\",
\n    \"value\": \"new value\"
\n}\n<\/td>\n		\nTests if a property has a specified value.
\n\u6d4b\u8bd5\u5c5e\u6027\u662f\u5426\u5177\u6709\u6307\u5b9a\u7684\u503c\u3002\n<\/td>\n<\/tr>\n<\/table>\n
After all this theory, we are ready to dive into the coding part.
\n\u5728\u6240\u6709\u8fd9\u4e9b\u7406\u8bba\u4e4b\u540e\uff0c\u6211\u4eec\u51c6\u5907\u6df1\u5165\u7814\u7a76\u7f16\u7801\u90e8\u5206\u3002<\/p>\n
12.1 Applying PATCH to the Employee Entity<\/h2>\n
Before we start with the controller modification, we have to install two required libraries:
\n\u5728\u5f00\u59cb\u4fee\u6539\u63a7\u5236\u5668\u4e4b\u524d\uff0c\u6211\u4eec\u5fc5\u987b\u5b89\u88c5\u4e24\u4e2a\u5fc5\u9700\u7684\u5e93\uff1a<\/p>\n