Search code examples
restpostput

In REST is POST or PUT best suited for upsert operation?

I keep a key-value storage in the server for the client. If the user sends key "k1", then I upsert it to the database. Is this considered POST or PUT?

Also I have another operation that removes all existing keys and adds the new key. Is this POST or PUT because it clears records and adds a new one.

Solution

  • If the user sends key k1, and I upsert it to the database, is this considered POST or PUT?

    According to the HTTP specification:

    The PUT method requests that the enclosed entity be stored under the supplied Request-URI. If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a modified version of the one residing on the origin server. If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new resource by the requesting user agent, the origin server can create the resource with that URI.

    I therefore think that the use of PUT for an insert or update is perfectly legitimate, provided that in both cases the URI is known in advance. If you're using the key as part of the URI (as k1 in http://www.somewhere.com/resources/k1) this should be the case. To be ideally RESTful, however, a GET to the same URL should also allow you to download the resource.

    I have another operation that removes all existing keys and adds the new key. Is this a POST or PUT operation, since it clears records and adds a new one?

    I don't think this operation could be considered RESTful since it does two things. It seems to be providing a macro to satisfy the needs of a particular client, rather than simple access to data. A standard RESTful design would be:

    1. Getting a list of keys by sending a GET to the parent URL. In the example above, that would be http://www.somewhere.com/resources;
    2. Deleting each of those keys by sending a DELETE to http://www.somewhere.com/resources/k1;
    3. Adding the replacement by sending a PUT to http://www.somewhere.com/resources/k2.

    It's less clear cut, but I think it would also be legitimate to delete all resources by sending a single DELETE request to http://www.somewhere.com/resources.