JSON Patch es un formato estándar web para describir cambios en un documento JSON . Está diseñado para usarse junto con HTTP PATCH , que permite la modificación de recursos HTTP existentes. El tipo de medio de JSON Patch es application/json-patch+json.
Descripción general
Un documento JSON Patch está estructurado como una matriz JSON de objetos, donde cada objeto contiene una de las seis operaciones de JSON Patch: agregar, eliminar, reemplazar, mover, copiar y probar. Esta estructura fue influenciada por la especificación de XML Patch. La sintaxis es la siguiente: [ 1 ] [ 2 ]
Se realiza una operación por objeto, aunque puede haber varios objetos/operaciones en cada arreglo. Estas operaciones se ejecutan en orden: la primera operación del arreglo se realiza primero, la segunda actúa sobre el resultado de la anterior, y así sucesivamente.
Los documentos JSON Patch son atómicos, lo que significa que si falla una operación en el documento, no se llevará a cabo ninguna otra.
Operaciones
Las operaciones realizan lo siguiente:
- Agregar
- agrega un valor a un objeto o matriz.
- Eliminar
- Elimina un valor de un objeto o matriz.
- Reemplazar
- Reemplaza un valor. Es lógicamente idéntico a usar remove y luego add.
- Copiar
- Copia un valor de una ruta a otra sumando el valor de una ubicación específica a otra ubicación.
- Mover
- Mueve un valor de un lugar a otro quitándolo de una ubicación y agregándolo a otra.
- Prueba
- pruebas de igualdad en una determinada ruta para un determinado valor. [ 3 ]
Referencias
- ↑ Mark, Nottingham; Paul, Bryan (abril de 2013). "Parche de notación de objetos JavaScript (JSON)" . tools.ietf.org . Consultado el 4 de diciembre de 2016 .
- ↑ "Blog de mnot: Por qué PATCH es bueno para tu API HTTP" . www.mnot.net . Consultado el 4 de diciembre de 2016 .
- ↑ Foster, Ben (11 de abril de 2016). "Cómo realizar actualizaciones parciales de recursos con JSON Patch y ASP.NET Core" . benfoster.io .
- JavaScript
- JSON
- Formatos abiertos
- Esbozos de programación informática