Poprawka JSON

Poprawka JSON
Rozszerzenie nazwy pliku
.json-patch
Rodzaj mediów internetowych
application/json-patch+json
Opracowany przez P. Bryan, M. Nottingham
Przedłużony od JSON

JSON Patch to standardowy format sieciowy do opisywania zmian w dokumencie JSON . Jest przeznaczony do użytku razem z HTTP Patch , który pozwala na modyfikację istniejących zasobów HTTP. Typ nośnika poprawki JSON to application/json-patch+json .

Dokument JSON Patch ma strukturę tablicy obiektów JSON, gdzie każdy obiekt zawiera jedną z sześciu operacji JSON Patch: dodawanie, usuwanie, zastępowanie, przenoszenie, kopiowanie i testowanie. Na taką strukturę miała wpływ specyfikacja XML . Składnia wygląda następująco:

Na obiekt przypada jedna operacja, chociaż w każdej tablicy może być wiele obiektów/operacji. Te operacje są wykonywane w kolejności; pierwsza operacja w tablicy odbywa się jako pierwsza, druga operacja działa na wyniku poprzedniej operacji i tak dalej.

Dokumenty JSON Patch są atomowe, jeśli jedna operacja w dokumencie nie powiedzie się, żadna operacja nie zostanie przeprowadzona.

Operacje

Operacje wykonują następujące czynności:

Dodaj: dodaje wartość do obiektu lub tablicy.

Usuń: usuwa wartość z obiektu lub tablicy.

Zastąp: zastępuje wartość. Logicznie identyczny z użyciem usuwania, a następnie dodawania.

Kopiuj: kopiuje wartość z jednej ścieżki do drugiej, dodając wartość w określonej lokalizacji do innej lokalizacji.

Przenieś: przenosi wartość z jednego miejsca do drugiego, usuwając je z jednego miejsca i dodając do innego.

Test: testy równości na określonej ścieżce dla określonej wartości.