Oprava JSON - JSON Patch

Oprava JSON
Přípona názvu souboru
.json-patch
Typ internetového média
application / json-patch + json
VyvinulP. Bryan, M. Nottingham
Rozšířeno zJSON

Oprava JSON je webový standard formát pro popis změn v a JSON dokument. Je určen k použití společně s HTTP Náplast což umožňuje úpravu stávajících prostředků HTTP. Oprava JSON typ média je application / json-patch + json.

Dokument JSON Patch je strukturován jako pole JSON objektů, kde každý objekt obsahuje jednu ze šesti operací JSON Patch: přidat, odebrat, nahradit, přesunout, zkopírovat a otestovat. Tato struktura byla ovlivněna specifikací XML náplast. Syntaxe vypadá takto:[1][2]

[    { „op“: "přidat", "cesta": „/ myPath“, "hodnota": ["myValue"] }]

Každý objekt má dva povinné členy: „op“ a „cesta“.

Na jeden objekt existuje jedna operace, i když v každém poli může být mnoho objektů / operací. Tyto operace jsou prováděny v pořadí; první operace v poli jde jako první, druhá operace působí na výsledek předchozí operace atd.

Dokumenty JSON Patch jsou atomové v tom, že pokud jedna operace v dokumentu selže, nebude provedena žádná operace.

Operace

Operace provádějí následující:

Přidat: přidá hodnotu do objektu nebo pole.

Odstranit: odebere hodnotu z objektu nebo pole.

Nahradit: nahradí hodnotu. Logicky shodné s použitím remove a then add.

Kopírovat: zkopíruje hodnotu z jedné cesty do druhé přidáním hodnoty v zadaném umístění do jiného umístění.

Hýbat se: přesune hodnotu z jednoho místa na druhé odebráním z jednoho místa a přidáním na jiné.

Test: testuje rovnost na určité cestě pro určitou hodnotu.[3]

Reference

  1. ^ Mark, Nottingham; Paul, Bryan. "Oprava objektu JavaScript (JSON)". tools.ietf.org. Citováno 2016-12-04.
  2. ^ „blog mnot: Why PATCH is good for your HTTP API“. www.mnot.net. Citováno 2016-12-04.
  3. ^ Foster, Ben (11. dubna 2016). "Jak provádět částečné aktualizace prostředků pomocí JSON Patch a ASP.NET Core". benfoster.io.