People who come from WCF/ Web Services background and transition to RESTish type communication infrastructure make mistakes that follow a common pattern. I have seen it with people who are new to REST and with people who have spent some time working with RESTful services. (Throughout the post where every I mention REST I mean REST over HTTP) The common misconceptions are
- Not understanding the difference between HTTP POST and GET, in fact having too little or no clue about HTTP Verbs. For most devs interaction with server involves calling a client proxy method, handling the request on server, sending a response back from server, handling the response on client. This abstraction means no one knows what happens at infrastructure level. When programming for HTTP one cannot ignore the abstraction, else we cannot take full advantage of the medium.
- The manifestation of the above affect is, either every call becomes a POST or every call becomes a GET.
- When every call becomes GET. All CRUD are done through url. I have seen people trying to do crazy stuff with urls just to pass data from client to server.
- When every call becomes POST (easy to do as compared to GET) , we fail to leverage the advantages of GET.
- Assuming making HTTP call via GET\POST makes a service RESTful. This is a very common misconception and I too am culprit of thinking the same. But as I read more about REST and looked at examples I realize how far was I from a real RESTful implementation. I highly recommend REST In Practice book which is a great resource if one is serious about understanding REST.
- Thinking the performance gains comes due to absence of SOAP envelop. The real performance gains come when data gets cached. This caching can occur at different locations starting from the servers network (reverse proxies), intermediaries, client network (proxies) and client browser.
- Creating RESTful service and marking most of GET's as non cacheable. The common cause of this is not understanding the cache expiration in HTTP and therefore not taking advantage of it. Moreover during debugging cycles cached data is a pain to work with when one wants to test his\her fix.
These are some of the patterns that are at top of my head. What else can be added?