JSON-patch

JSON-patch
Filnamnstillägg
.json-patch
Internet mediatyp
application/json-patch+json
Utvecklad av P. Bryan, M. Nottingham
Förlängt från JSON

JSON Patch är ett webbstandardformat för att beskriva ändringar i ett JSON- dokument. Det är tänkt att användas tillsammans med HTTP Patch som möjliggör modifiering av befintliga HTTP-resurser. JSON Patch- medietypen är application/json-patch+json .

Ett JSON Patch-dokument är strukturerat som en JSON-array av objekt där varje objekt innehåller en av de sex JSON Patch-operationerna: lägg till, ta bort, ersätt, flytta, kopiera och testa. Denna struktur påverkades av specifikationen för XML- patch. Syntaxen ser ut så här:

Det finns en operation per objekt, även om det kan finnas många objekt/operationer i varje array. Dessa operationer utförs i ordning; den första operationen i arrayen går först, den andra operationen påverkar resultatet av den föregående operationen och så vidare.

JSON Patch-dokument är atomära i det att om en operation i dokumentet misslyckas, kommer ingen operation att utföras.

Operationer

Operationerna gör följande:

Lägg till: lägger till ett värde i ett objekt eller array.

Ta bort: tar bort ett värde från ett objekt eller array.

Ersätt: ersätter ett värde. Logiskt identisk med att använda ta bort och sedan lägga till.

Kopiera: kopierar ett värde från en sökväg till en annan genom att lägga till värdet på en angiven plats till en annan plats.

Flytta: flyttar ett värde från en plats till en annan genom att ta bort från en plats och lägga till en annan.

Test: testar för jämlikhet vid en viss väg för ett visst värde.