CODEWITHSUNDEEP
httphttp-method
Adam Zerner
Adam Zerner

Reputation: 19168

Why would you use PUT instead of PATCH?

From what I understand, PUT requests send the whole object while PATCH requests just send the diff, which is used to update the object in the database.

Why would you do a PUT over a PATCH? PATCH seems much lighter. I don't see any upsides to PUT (I'm sure they exist, I just don't know what they are).

Upvotes: 6

Views: 3840

Answers (4)

BlackGlory
BlackGlory

Reputation: 4033

A considerable part of the HTTP standard is outdated, so it is not surprising that PATCH can completely replace PUT.

In RESTful API, people often mistakenly regard PUT as "update the entire resource", but in fact the semantics of PUT is "replace the resource". Unfortunately, there is a sad design in the HTTP: PUT is defined to create new resources when they don't exist, so PUT is sometimes used as an idempotent alternative to POST.

PATCH is an imitation of PUT to a certain extent, so it also incorporates part of the responsibilities of POST. However, if you only want to have an action of "modify the existing resource", you only need to use PATCH (PATCH is not idempotent, another sad design of HTTP).

Those who study REST and HTTP standard methods in depth will eventually find that a simple RPC interface can better implement all the actions you need.

Upvotes: -1

Frank
Frank

Reputation: 9

  • with using POST as only option to create resources
  • only having JSON resources (RFC 7396)
  • making your PATCH endpoint implementation idempotent

Is there still a need to provide a PUT endpoint in an API?

Maybe I don't want to take the diff and deduce where I should save it so that everything makes sense. Maybe I just want to work with full resources instead of messing around with little parts of them. >> you can use PATCH for full update as well, no?

Upvotes: 0

ma499
ma499

Reputation: 636

A better way of looking at is that PUT replaces a resource, whilst PATCH is for providing an instruction to change a resource.

Replacing a resource is always a safe and idempotent operation as it has no dependency on the existing state of the resource. Meanwhile a request to change a resource may be dependent on the state of that resource and can therefore have other effects.

The HTTP PATCH verb is defined in RFC 5789, which states:

The difference between the PUT and PATCH requests is reflected in the way the server processes the enclosed entity to modify the resource identified by the Request-URI. In a PUT request, the enclosed entity is considered to be a modified version of the resource stored on the origin server, and the client is requesting that the stored version be replaced. With PATCH, however, the enclosed entity contains a set of instructions describing how a resource currently residing on the origin server should be modified to produce a new version. The PATCH method affects the resource identified by the Request-URI, and it also MAY have side effects on other resources; i.e., new resources may be created, or existing ones modified, by the application of a PATCH.

It goes on to say:

PATCH is neither safe nor idempotent

Upvotes: 5

Julian Reschke
Julian Reschke

Reputation: 41997

You might want to create the resource, or there might not be an applicable PATCH format available (think binary files).

Upvotes: 2

Related Questions