Come supportare gli aggiornamenti parziali (PATCH) in REST

Question

Voglio implementare gli aggiornamenti parziali per la mia risorsa in quanto ho una grande risorsa e voglio aggiornare le informazioni parziali da essa. Ho seguito i seguenti link ma non
per capire se utilizzare i metodi HTTP POST o PATCH.

HTTP MODIFY verb for REST?

How to submit RESTful partial updates?

http://jacobian.org/writing/rest-worst-practices/

https://github.com/archiloque/rest-client/issues/79

http://tools.ietf.org/html/draft-dusseault-http-patch-16

http://greenbytes.de/tech/webdav/draft-dusseault-http-patch-06.html

http://jasonsirota.com/rest-partial-updates-use-post-put-or-patch

http://bitworking.org/news/296/How-To-Do-RESTful-Partial-Updates

https://github.com/dharmafly/jsonpatch.js

Per qualsiasi proposta valida soluzione per questo.

Answer 1

Secondo RFC5789 (http://tools.ietf.org/html/rfc5789), questo è esattamente ciò che è PATCH per:

Diverse applicazioni alla proroga del protocollo Hypertext Transfer (HTTP) richiedono una funzionalità per eseguire una modifica parziale delle risorse. Il metodo PUT HTTP consente solo la sostituzione completa di un documento. Questa proposta aggiunge un nuovo metodo HTTP, PATCH, per modificare una risorsa HTTP esistente.

La distinzione tra PATCH e PUT è descritto come:

La differenza tra i PUT e patch richieste si riflette nel modo il server elabora l'entità allegata per modificare la risorsa identificata dal richiesta-URI. In una richiesta PUT, l'entità inclusa è considerata una versione modificata della risorsa memorizzata sul server di origine e il client richiede che la versione memorizzata venga sostituita. Con PATCH, tuttavia, l'entità inclusa contiene un set di istruzioni che descrivono come una risorsa che attualmente risiede sul server di origine deve essere modificata per produrre una nuova versione.Sono anche descritti

Le limitazioni di POST:

Il metodo PUT è già definito per sovrascrivere una risorsa con un nuovo corpo completo, e non può essere riutilizzato per fare modifiche parziali. In caso contrario, proxy e cache, e persino client e server, potrebbero ottenere confuso sul risultato dell'operazione. POST è già in uso, ma senza ampia interoperabilità (per uno, non esiste un modo standard per scoprire supporto per il formato di patch) [...]

vorrei suggerire di leggere la RFC e rendere la vostra propria mente, ma a me sembra abbastanza chiaro - le richieste PATCH dovrebbero essere elaborate come aggiornamenti parziali. (NB non sono idempotente, a differenza di PUT.)

EDIT: come ha sottolineato Eugene nei commenti, anche se le richieste di patch vengono "neither safe nor idempotent as defined by [RFC2616]", possono essere realizzati in modo da:

Una richiesta patch può essere rilasciato in modo tale da essere idempotente, , che aiuta anche a prevenire i cattivi risultati dalle collisioni tra due richieste di PATOLOGIA sulla stessa risorsa in un intervallo di tempo simile. Le collisioni da più richieste PATCH possono essere più pericolose delle collisioni PUT perché alcuni formati di patch devono operare da un punto base noto altrimenti corromperanno la risorsa. Client utilizzando questo tipo di applicazione di patch DOVREBBE utilizzare una richiesta condizionale tale che la richiesta avrà esito negativo se la risorsa è stata aggiornata poiché l'ultimo accesso al client della risorsa. Ad esempio, il client può utilizzare un forte ETag [RFC2616] in un'intestazione If-Match sulla richiesta PATCH .

Answer 2

PATCH deve essere utilizzato con un formato patch, solo per il patching a livello di documento (noto anche come diff sulla rappresentazione effettiva). Il suo uso per altri scopi è dubbio e discutibile, e non è chiaro che il metodo sia stato progettato per usi di tipo non multimediale.

In generale, un POST rappresenta l'approccio corretto, ma è preferibile dividere la risorsa in più risorse e modificarla.

[Modificato per chiarezza, come alcuni non leggono commenti]

Answer 3

È necessario utilizzare il metodo PATCH come descritto in RFC-7386 "JSON merge PATCH".

E.g. se si desidera modificare il valore di "a" e la rimozione di "f" in risorsa come:

{ 
    "a": "b", 
    "c": { 
     "d": "e", 
     "f": "g" 
    } 
    } 

È possibile raggiungere questo obiettivo con l'invio:

 PATCH /target HTTP/1.1 
     Host: example.org 
     Content-Type: application/merge-patch+json 

     { 
     "a":"z", 
     "c": { 
      "f": null 
     } 
     }