35

Do You Need PUT and PATCH?

 5 years ago
source link: https://www.tuicool.com/articles/hit/AnaeInn
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

Conventional wisdom says that REST APIs should be implemented as follows:

  •   GET   — read
  •   POST  —  add
  •   PUT / PATCH   — modify
  •   DELETE   — remove

This mostly works well. Query parameters can be used to supply arguments for GET   and  DELETE   operations.   POST s can use either URL-encoded or multipart form data, standard encodings supported by nearly all web browsers, and other HTTP clients.

J7BbqmV.jpg!web

However, it doesn't work quite as well for PUT   or  PATCHPUT   has no standard encoding and requires the entire resource to be sent in the payload.  PATCH   was introduced as a workaround to this limitation, but it also lacks a standard encoding and is not supported by all clients (notably Java).

However, the POST  method can also be used to modify resources. The semantics of  POST   are less strict than  PUT , so it can support partial updates like  PATCH . Further, the same encoding used for creating resources (either URL-encoded or multipart) can also be used for updates.

For example:

  • POST /products   — add a new resource to the "products" collection using the data specified in the request body  
  • POST /products/101   — update the existing resource with ID 101 in the products collection using the (possibly partial) data specified in the request body

This approach works particularly well when resources are backed by relational database tables. An "add" POST   maps directly to a SQL  INSERT   operation, and a "modify"  POST   translates to a SQL  UPDATE . The key/value pairs in the body (whether URL-encoded or multipart) map directly to table column names and values.

The approach also supports bulk inserts and updates. POST ing a URL-encoded payload works well for individual records, but JSON, CSV, or XML could easily be used to add or update multiple records at a time.

So, do you really need PUT   and  PATCH ? Given that  POST is more flexible, better supported, and can handle both create and update operations, I'd say no. Please share your thoughts in the comments!


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK