Hypermedia APIs with Spring

Slides of my talk at OOP 2013 on how to implement hypermedia driven REST web services using Spring technologies

1. REST Assured Hypermedia APIs with Spring Oliver Gierke
2. Oliver Gierke SpringSource Engineer Spring Data ogierke@vmware.com olivergierke www.olivergierke.de
3. Background
4. REST
5. REST Resources URIs Uniform Interface Representations Hypermedia
6. Hypermedia
7. Hypermedia Links in representations State navigations discoverable
8. "HATEOAS - the word, there's no pronounciation for. (Ben Hale, SpringOne2GX 2012)
9. REST in practice
11. RESTBucks
12. RESTBucks Starbucks (like) coffee ordering Order / Payment
14. payment expected 1
15. payment expected 1 2
16. payment expected cancelled 1 2 3
17. payment expected preparing cancelled 1 2 3 4
18. payment expected preparing cancelled ready 1 2 3 4 5
19. payment expected preparing cancelled ready completed 1 2 3 4 5 6
20. Method URI Action Step POST /orders Create new order 1 POST/PATCH /orders/4711 Update the order (only if "payment expected") 2 DELETE /orders/4711 Cancel order (only if "payment expected") 3 PUT /orders/4711/payment Pay order 4 Barista preparing the order Barista preparing the order Barista preparing the order Barista preparing the order GET /orders/4711 Poll order state 5 GET /orders/4711/receipt Access receipt DELETE /orders/4711/receipt Conclude the order process 6
21. Challenges
22. Challenges How to avoid hard coding URIs?
23. Use link relations
24. orders Returns all orders available in the system order Returns a single order self The uri value can be used to GET the latest resource representation of the order. cancel This is the URI to be used to DELETE the order resource should the consumer wish to cancel the order. update Consumers can change the order using a POST to transfer a representation to the linked resource. payment The linked resource allows the consumer to begin paying for an order. Initiating payment involves PUTting an appropriate resource representation to the specified URI. receipt The URI to access the receipt using GET and conclude the order by taking the receipt (use DELETE).
25. orders Returns all orders available in the system order Returns a single order self The uri value can be used to GET the latest resource representation of the order. cancel This is the URI to be used to DELETE the order resource should the consumer wish to cancel the order. update Consumers can change the order using a POST to transfer a representation to the linked resource. payment The linked resource allows the consumer to begin paying for an order. Initiating payment involves PUTting an appropriate resource representation to the specified URI. receipt The URI to access the receipt using GET and conclude the order by taking the receipt (use DELETE).
26. Method URI Action Step POST /orders Create new order 1 POST/PATCH /orders/4711 Update the order (only if "payment expected") 2 DELETE /orders/4711 Cancel order (only if "payment expected") 3 PUT /orders/4711/payment Pay order 4 Barista preparing the order Barista preparing the order Barista preparing the order Barista preparing the order GET /orders/4711 Poll order state 5 GET /orders/4711/receipt Access receipt DELETE /orders/4711/receipt Conclude the order process 6
27. Method Relation type Action Step POST orders Create new order 1 POST/PATCH order Update the order (only if "payment expected") 2 DELETE order Cancel order (only if "payment expected") 3 PUT payment Pay order 4 Barista preparing the order Barista preparing the order Barista preparing the order Barista preparing the order GET order Poll order state 5 GET receipt Access receipt DELETE receipt Conclude the order process 6
28. Challenges How to implement: "only if payment expected"?
29. Process modeling
30. Root resource The only URI known GET /
31. { links : [ { rel : "orders", href : "…/orders" } ] }
32. Place order Access root resource Follow orders link $.links[?(@.rel="orders")].href POST /orders
33. { links : [ { rel : "orders", href : "…/orders" } ] }
34. { links : [ { rel : "self", href : "…/orders/4711" }, … { rel : "payment", href : "…/orders/4711/payment" } ], content : { items : [ { drink : "Cappucino", size : "large", milk : "semi" price : 4.2 } ], location : "take-away", price : 4.2 status : "payment expected" } }
35. Trigger payment Follow payment link $.links[?(@.rel="payment")].href PUT /orders/4711/payment
36. { links : [ { rel : "self", href : "…/orders/4711" }, … { rel : "payment", href : "…/orders/4711/payment" } ], content : { items : [ { drink : "Cappucino", size : "large", milk : "semi" price : 4.2 } ], location : "take-away", price : 4.2 status : "payment expected" } }
37. { links : [ { rel : "self", href : "…/orders/4711/payment" }, { rel : "order", href : "…/orders/4711" } ], content : { creditCard : [ { number : "1234123412341234", cardHolder : "Oliver Gierke", expiryDate : "2013-11-01" } ], amount : { currency : "EUR", value : 4.2 } } }
38. Poll order Follow order link $.links[?(@.rel="order")].href GET /orders/4711 ETag / If-None-Match
39. { links : [ { rel : "self", href : "…/orders/4711/payment" }, { rel : "order", href : "…/orders/4711" } ], content : { creditCard : [ { number : "1234123412341234", cardHolder : "Oliver Gierke", expiryDate : "2013-11-01" } ], amount : { currency : "EUR", value : 4.2 } } }
40. { links : [ { rel : "self", href : "…/orders/4711" } ], content : { items : [ { drink : "Cappucino", size : "large", milk : "semi" price : 4.2 } ], location : "take-away", price : 4.2 status : "preparing" } }
41. Poll order Use caching ETag / If-None-Match until…
42. { links : [ { rel : "self", href : "…/orders/4711" }, { rel : "receipt", href : "…/orders/4711/receipt" } ], content : { items : [ { drink : "Cappucino", size : "large", milk : "semi" price : 4.2 } ], location : "take-away", price : 4.2 status : "ready" } }
43. Access receipt Follow receipt link $.links[?(@.rel="receipt")].href GET /orders/4711/receipt
44. { links : [ { rel : "self", href : "…/orders/4711" }, { rel : "receipt", href : "…/orders/4711/receipt" } ], content : { items : [ { drink : "Cappucino", size : "large", milk : "semi" price : 4.2 } ], location : "take-away", price : 4.2 status : "ready" } }
45. Conclude order Follow receipt link $.links[?(@.rel="receipt")].href DELETE /orders/4711/receipt
46. Hypermedia VS. Java Frameworks
47. HTTP Methods URI Mapping Content negotiation Hypermedia Spring MVC JAX-RS ✓ ✓ ✓ ✓ ✓ ✓ ? ?
48. Spring RESTBucks
49. Spring RESTBucks Sample implementation Using Spring technologies http://bit.ly/spring-restbucks
50. Web Service Repository - Orders Spring Data Spring Data REST Payment Spring Data Manual implementation Manual implementation
51. DEMO
52. payment expected preparing cancelled ready completed 1 2 3 4 5 6
53. Spring HATEOAS
54. Spring HATEOAS Representation models LinkBuilder API Representation enrichment http://bit.ly/spring-hateoas
55. Spring Data REST
56. Spring Data REST Exports JPA repositories as resources Hypermedia driven representations Extension points http://bit.ly/sd-rest
57. REST Shell
58. REST Shell Explore REST webservices Hypermedia driven Spring HATEOAS link format brew install rest-shell
59. Thank you!
60. Resources
61. Code Spring RESTBucks Spring Data REST Spring HATEOAS REST Shell
62. Books REST in Practice REST und HTTP RESTful WebServices Cookbook Spring Data
63. Videos Hypermedia APIs - Jon Moore Hypermedia APIs with Spring