RESTful http_patterns_antipatterns
•
1 like•2,677 views
This document summarizes RESTful and unRESTful HTTP patterns. It discusses how REST aims to address issues with network-based, decentralized systems by constraining architectural elements. Some common anti-patterns are described, such as RPC over URI and HTTP tunneling, which violate REST principles. Best practices for RESTful HTTP include identifying resources, manipulating resources through representations, using self-descriptive messages, and making application state discoverable through hypermedia.
Recommended
More Related Content
What's hot
What's hot (19)
Similar to RESTful http_patterns_antipatterns
Similar to RESTful http_patterns_antipatterns (20)
Recently uploaded
Recently uploaded (20)
RESTful http_patterns_antipatterns
- 1. RESTful HTTP Patterns and Anti-Patterns Jan Algermissen prioconference 2010, Nürnberg
- 2. Jan Algermissen “Applying the Web to Enterprise IT” @algermissen algermissen@acm.org http://www.nordsc.com/blog NORD Software Consulting http://www.nordsc.com/
- 3. REST
- 5. An architectural style for network-based software architectures
- 6. HTTP
- 7. RESTful HTTP The Web used correctly
- 8. 1991 HTTP 0.9 HTTP 1.1 HTTP 1.0 Start HTTP 1.1bis 2000 REST 2007 1996
- 12. Architectural Style A set of constraints on architectural elements. To achieve certain system properties.
- 15. Network-Based (ODBC) User Use Case Application Components Connector
- 16. User Use Case Application Connector Components Network-Based (ODBC)
- 17. Application User Agent Component Server Component Intermediary Component Connectors Network-Based (HTTP) User Use Case
- 18. User Use Case Application User Agent Component Server Component Intermediary Component Connectors Administrative Domain Network-Based (HTTP)
- 22. Manipulation of resources through representations Self-descriptive messages Hypermedia as the engine of application state REST Four core constraints Identification of resources
- 23. Identification of resources Manipulation of resources through representations Self-descriptive messages Hypermedia as the engine of application state REST
- 25. Identification of resources Manipulation of resources through representations Self-descriptive messages Hypermedia as the engine of application state REST
- 28. GET /catalog GET /products/667 GET /products?search=lego POST /orders/ PUT /orders/42 DELETE /orders/42 POST /payment-notifications/ GET /orders/2009/?month=June GET /orders/payment-pending DELETE /accounts/bob PUT /orders/42/state GET DELETE PUT POST
- 29. Identification of resources Manipulation of resources through representations Self-descriptive messages Hypermedia as the engine of application state REST
- 30. GET /srv/orders/6651 HTTP/1.1 200 Ok Date: Mon, 18 Oct 2010 21:40:29 GMT Server: Apache/2 ETag: "12345" Cache-Control: public, max-age=3600 Content-Type: application/vnd.oasis.ubl <order> <items> ... </items> <total currency=”USD” amount=”52.77”/> </order>
- 32. Identification of resources Manipulation of resources through representations Self-descriptive messages Hypermedia as the engine of application state REST
- 33. GET /order-form.html 200 Ok Content-Type: text/html <html><body> <form action=”/orders” method=”POST”> <img src=”/img/dish-A.jpg”/> <img src=”/img/dish-B.jpg”/> <input type=”text” name=”dish”/> <input type=”submit” value=”Order Now”/> </form> </body></html>
- 34. GET /srv/catalog 200 Ok Content-Type: application/vnd.oasis.ubl Link: </srv/about>;rel=”service” <catalog href=”/srv/catalog”> <order-processor href=”/srv/orders” accept=”application/vnd.oasis.ubl”/> <item href=”/srv/products/2213-21”> <name> .... </name> </item> <item href=”/srv/products/2213-22”> <name> .... </name> </item> </catalog>
- 35. Example System
- 36. CATALOG
- 41. RPC URI-Tunneling w/GET GET /srv/?action=getCatalog GET /srv/?action=getDetails&productID=2213-21 GET /srv/?action=placeOrder&itemIDs=23,455,12 GET /srv/?action=changeOrder&orderId=42&newiItemId=25 GET /srv/?action=cancelOrder&orderId=42 GET /srv/?action=notifyPayment&orderId=42 GET /srv/?action=getReport&year=2009&week=34
- 42. RPC URI-Tunneling POST /srv/?action=getCatalog POST /srv/?action=getDetails&productID=2213-21 POST /srv/?action=placeOrder&itemIDs=23,455,12 POST /srv/?action=changeOrder&orderId=42&newiItemId=25 POST /srv/?action=cancelOrder&orderId=42 POST /srv/?action=notifyPayment&orderId=42 POST /srv/?action=getReport&year=2009&week=34
- 43. Performance Scalability Simplicity Visibility Evolvability POST /srv/?action=getDetails&productID=2213-21 POST /srv/?action=changeOrder&orderId=42&newiItemId=25 POST /srv/?action=notifyPayment&orderId=42
- 44. HTTP-Based Type I GET /srv/catalog GET /srv/products/2213-21 POST /srv/orders PUT /srv/orders/42 DELETE /srv/orders/42 POST /srv/payment-notifications GET /srv/reports/2009/34 Service Description: •Fixed list of URIs •WADL or equiv. •Service specific XML • Fixed, no content negotiation
- 45. GET /srv/products/2213-21 200 Ok Content-Type: application/xml <item xmlns=”...”> <name>Lego Tower Bridge</name> <description> ... </description> <inStock>26</inStock> <item>
- 46. Performance Scalability Simplicity Visibility Evolvability GET /srv/catalog GET /srv/products/2213-21 POST /srv/orders PUT /srv/orders/42 DELETE /srv/orders/42 POST /srv/payment-notifications
- 47. HTTP-Based Type II GET /srv/catalog GET /srv/products/2213-21 POST /srv/orders PUT /srv/orders/42 DELETE /srv/orders/42 POST /srv/payment-notifications GET /srv/reports/2009/34 Service Description: •Fixed list of URIs •WADL or equiv. •Use of ‘standard’ media types • Fixed, no content negotiation
- 48. GET /srv/products/2213-21 200 Ok Content-Type: application/vnd.oasis.ubl <item xmlns=”...”> <name>Lego Tower Bridge</name> <description> ... </description> <inStock>26</inStock> <item>
- 49. Performance Scalability Simplicity Visibility Evolvability GET /srv/catalog GET /srv/products/2213-21 POST /srv/orders PUT /srv/orders/42 DELETE /srv/orders/42 POST /srv/payment-notifications
- 50. RESTful HTTP
- 52. GET /srv/catalog 200 Ok Content-Type: application/vnd.oasis.ubl Link: </srv/about>;rel=”service” <catalog href=”/srv/catalog”> <order-processor href=”/srv/orders” accept=”application/vnd.oasis.ubl”/> <item href=”/srv/products/2213-21”> <name> .... </name> </item> <item href=”/srv/products/2213-22”> <name> .... </name> </item> </catalog>
- 53. GET /srv/about 200 Ok Content-Type: application/atomsvc+xml <service> <workspace> <collection href=” /srv/payment-notifications”/> <category term=”oms:remittance-advice”/> <accept>application/vnd.oasis.ubl</accept> </collection> <collection href=”/srv/reports/”/> <category term=”oms:report”/> <category term=”oms:weekly”/> <accept/> </collection> </workspace> </service>
- 54. Performance Scalability Simplicity Visibility Evolvability GET /srv/catalog Media Types (service independent) Find transitions at runtime
- 56. Take Aways •Network-based, decentralized creates issues. •Constrain architectural elements to deal with issues. •RPC URI tunneling is bad in all forms at no benefit whatsoever. •At least use HTTP Type I. •HTTP Type I might be just what you need (but its not REST).
- 57. The Web and Enterprise IT have a very similar problem space!
- 58. Thank you!
- 60. 1991 HTTP 0.9 HTTP 1.1 HTTP 1.0 Start HTTP 1.1bis 2009 2000 “SOA Is Dead” REST REST vs. SOAP war SOAP 1.1 SOAP 1.2 2007 1996