Download to read offline
![THANKS!
{
“is” : [“link” “list”],
rest-discuss: “http://tech.groups.yahoo.com/group/rest-discuss/”,
httpbis: “http://tools.ietf.org/wg/httpbis/”,
object-net: “http://the-object.net”,
}](https://image.slidesharecdn.com/rest-experience-report-120516115715-phpapp02/75/Rest-experience-report-81-2048.jpg)
Uploaded byJim Barritt
Rest experience-report
The document discusses building REST APIs and describes the principles of REST. It outlines the goals of building a REST API as a platform for innovation, long term stability, availability, uniform access, and low development costs. It describes using hypermedia and hyperlinks to navigate between resources and build stateless, cacheable APIs. The document provides examples of describing resources with XML or JSON, finding and retrieving single or multiple resources, and linking between related resources to build a RESTful workflow.
More Related Content
![Copyleft Presentasjon[1]](https://cdn.slidesharecdn.com/ss_thumbnails/copyleftpresentasjon1-090323163249-phpapp01-thumbnail.jpg?width=640&height=640&fit=bounds)
Rest experience-report
- 1. Building a RESTAPI Jim Barritt Marc Johnson
- 2. Building a RESTAPI Jim Barritt Marc Johnson
- 3. hypermedia Building a RESTAPI Jim Barritt Marc Johnson
- 4. Rise of theAPI
- 5. What do wewant?
- 6. What do wewant? • A platform for innovation
- 7. What do wewant? • A platform for innovation • Long term stability
- 8. What do wewant? • A platform for innovation • Long term stability • Available and performant
- 9. What do wewant? • A platform for innovation • Long term stability • Available and performant • Uniform, ubiquitous access
- 10. What do wewant? • A platform for innovation • Long term stability • Available and performant • Uniform, ubiquitous access • Low cost of development
- 11. What do wewant? • A platform for innovation • Long term stability • Available and performant • Uniform, ubiquitous access • Low cost of development • Evolvable
- 12. What do wewant? • A platform for innovation • Long term stability • Available and performant • Uniform, ubiquitous access • Low cost of development • Evolvable • Mashable
- 13. How do weget it?
- 14.
- 15. hypermedia <user> <userName>bob@foo.com</userName> <status>Active</status> </user> ?
- 16. hypermedia <user> <userName>bob@foo.com</userName> <status>Active</status> </user> rel=”entitlements” href=”...” /> <link </user> ?
- 17. hypermedia <user> <userName>bob@foo.com</userName> <status>Active</status> </user> rel=”entitlements” href=”...” /> <entitlements href=”http://...” /> <link </user> ?
- 18.
- 19.
- 20. hypermedia NO! http://api.com/users/{userId}/profile
- 21. hypermedia USER jimb@thoughtworks.com NO! http://api.com/users/{userId}/profile profile GET : http://... PROFILE
- 22. resources USERS POST USER jimb@thoughtworks.com
- 35. ? ? @duncancragg @jimwebber @mnot ? ? @fielding @mamund @ianrobinson http://tools.ietf.org/wg/httpbis/ http://tech.groups.yahoo.com/group/rest-discuss/
- 36.
- 37. application/xml vs application/json
- 38. application/vnd.foo+xml vs application/xml
- 39. application/atom+xml <link rel="profile" href="..."/> USER jimb@thoughtworks.com profile GET : http://... PROFILE
- 40.
- 41. Describing things.... <user> <userName>jimb@thoughtworks.com</userName> <status>Active</status> <link rel="profile" href="..." /> <link rel="entitlements" href="..." /> <link rel="licences" href="..." /> </user>
- 42.
- 43.
- 44. Finding things.... GET: /users?userName=jimb@thoughtworks.com vs POST:/users HTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search>
- 45.
- 46. Many things.... POST: /usersHTTP/1.1 <search> <country>UK</country> </search>
- 47. Many things.... POST: /usersHTTP/1.1 <search> <country>UK</country> </search> HTTP/1.1 200 OK Content-Type: application/xml <list of=”user”> <link rel="user" href="..." /> <link rel="user" href="..." /> <link rel="user" href="..." /> </site>
- 48.
- 49. One thing.... POST: /usersHTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search>
- 50. One thing.... POST: /usersHTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search> HTTP/1.1 200 OK Location: /users/234234
- 51. POST: /users HTTP/1.1 vs POST: /users/search HTTP/1.1
- 52. Linked resources... SITE USERS ENTITLEMENT USER PROFILE CREDIT BALANCE
- 53. <form method=”POST” action=”http://...”> vs POST: http://...
- 54.
- 56.
- 57. GET: /sites/jkshop HTTP/1.1 HTTP/1.1200 OK Content-Type: application/xml <site> <siteName>jkshop</siteName> <link rel="users" href="..." /> <link rel="authentication" href="..." /> </site>
- 58. GET: /sites/jkshop HTTP/1.1 HTTP/1.1200 OK Content-Type: application/xml <site> <siteName>jkshop</siteName> <link rel="users" href="..." /> <link rel="authentication" href="..." /> </site>
- 60. POST:/sites/jskshop/users HTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search>
- 61. POST:/sites/jskshop/users HTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search> HTTP/1.1 303 See Other Location: /users/234234
- 62. POST:/sites/jskshop/users HTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search> HTTP/1.1 303 See Other Location: /users/234234 GET:/users/234234 HTTP/1.1
- 63. POST:/sites/jskshop/users HTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search> HTTP/1.1 303 See Other Location: /users/234234 GET:/users/234234 HTTP/1.1 HTTP/1.1 200 OK Content-Type: application/xml <user> <userName>jimb@thoughtworks.com</userName> <status>Active</status> <userIdentifier>...</userIdentifier> <link rel="profile" href="..." /> <link rel="entitlements" href="..." /> <link rel="licences" href="..." /> </user>
- 64. POST:/sites/jskshop/users HTTP/1.1 <search> <userName>jimb@thoughtworks.com</userName> </search> HTTP/1.1 303 See Other Location: /users/234234 GET:/users/234234 HTTP/1.1 HTTP/1.1 200 OK Content-Type: application/xml <user> <userName>jimb@thoughtworks.com</userName> <status>Active</status> <userIdentifier>...</userIdentifier> <link rel="profile" href="..." /> <link rel="entitlements" href="..." /> <link rel="licences" href="..." /> </user>
- 66. POST: /users/234234/entitlements HTTP/1.1 <search> <onDate>23-01-2012</onDate> </search>
- 67. POST: /users/234234/entitlements HTTP/1.1 <search> <onDate>23-01-2012</onDate> </search> HTTP/1.1 303 See Other Location: /entitlements/234234/23-01-2012
- 68. POST: /users/234234/entitlements HTTP/1.1 <search> <onDate>23-01-2012</onDate> </search> HTTP/1.1 303 See Other Location: /entitlements/234234/23-01-2012 GET: /entitlements/234234/23-01-2012 HTTP/1.1
- 69. POST: /users/234234/entitlements HTTP/1.1 <search> <onDate>23-01-2012</onDate> </search> HTTP/1.1 303 See Other Location: /entitlements/234234/23-01-2012 GET: /entitlements/234234/23-01-2012 HTTP/1.1 HTTP/1.1 200 OK Content-Type: application/xml <entitlement> <entitledTo> <product name="FRUIT"> <productItem name="APPLES" /> </product> <link rel="licence" href="..." /> <link rel="seat" href="..." /> <link rel="credits" href="..." /> </entitledTo> </entitlement>
- 70. POST: /users/234234/entitlements HTTP/1.1 <search> <onDate>23-01-2012</onDate> </search> HTTP/1.1 303 See Other Location: /entitlements/234234/23-01-2012 GET: /entitlements/234234/23-01-2012 HTTP/1.1 HTTP/1.1 200 OK Content-Type: application/xml <entitlement> <entitledTo> <product name="FRUIT"> <productItem name="APPLES" /> </product> <link rel="licence" href="..." /> <link rel="seat" href="..." /> <link rel="credits" href="..." /> </entitledTo> </entitlement>
- 72.
- 73. GET: /credits/234234/23-01-2012 HTTP/1.1 HTTP/1.1200 OK Content-Type: application/xml <creditBalance> <amount>10</amount> </creditBalance>
- 74. GET: /credits/234234/23-01-2012 HTTP/1.1 HTTP/1.1200 OK Content-Type: application/xml <creditBalance> <amount>10</amount> </creditBalance> POST: /credits/234234/23-01-2012 HTTP/1.1 <decrement> <amount>2</amount> </decrement>
- 75. GET: /credits/234234/23-01-2012 HTTP/1.1 HTTP/1.1200 OK Content-Type: application/xml <creditBalance> <amount>10</amount> </creditBalance> POST: /credits/234234/23-01-2012 HTTP/1.1 <decrement> <amount>2</amount> </decrement> HTTP/1.1 200 OK
- 76. what would wedo next?
- 77. Inlining... <list of=”user”> <link rel="user" href="..." /> <link rel="user" href="..." /> <link rel="user" href="..." /> </site>
- 78. Inlining... <list of=”user”> <user href="..." /> <user href="..." /> <user href="..." /> </site>
- 79. Inlining... <list of=”user”> <user href="..."> <userName>jimb@thoughtworks.com</userName> <status>Active</status> </user> <user href="..." /> <user href="..." /> </site>
- 81. THANKS! { “is” : [“link” “list”], rest-discuss: “http://tech.groups.yahoo.com/group/rest-discuss/”, httpbis: “http://tools.ietf.org/wg/httpbis/”, object-net: “http://the-object.net”, }
Editor's Notes
- #2 Intro to me\n\nGive brief context of api \nEntitlements\nMultiple sites\nUsers\nLicences\nCredits\n\nExisting SOAP API\n
- #3 Intro to me\n\nGive brief context of api \nEntitlements\nMultiple sites\nUsers\nLicences\nCredits\n\nExisting SOAP API\n
- #4 \n
- #5 \n
- #6 \n
- #7 \n
- #8 \n
- #9 \n
- #10 \n
- #11 \n
- #12 \n
- #13 TWO IMPORTANT POINTS....\n
- #14 \n
- #15 \n
- #16 \n
- #17 \n
- #18 \n
- #19 \n
- #20 \n
- #21 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #22 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #23 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #24 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #25 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #26 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #27 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #28 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #29 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #30 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #31 Down on the upside - Kevlin Henney\n\nhttp://www.artima.com/weblogs/viewpost.jsp?thread=341297\n
- #32 \n
- #33 \n
- #34 \n
- #35 \n
- #36 \n
- #37 \n
- #38 \n
- #39 \n
- #40 \n
- #41 \n
- #42 \n
- #43 \n
- #44 \n
- #45 \n
- #46 \n
- #47 http://crazytownmayor.com/blog/wp-content/uploads/2010/02/Footprints.png\n
- #48 \n
- #49 \n
- #50 \n
- #51 \n
- #52 \n
- #53 \n
- #54 \n
- #55 \n
- #56 \n
- #57 \n
- #58 \n
- #59 \n
- #60 \n
- #61 \n
- #62 \n
- #63 \n
- #64 \n
- #65 http://www.ba-stores.com/product-logos/originals/20820_WC20StretchingTimeClock.jpg\n\njson and xml\ninlining\nshortcuts\nrepresentation framework\ncaching+etags\n\nCompatibility matrix testing\nPerformance testing\n\n\n
- #66 \n
- #67 \n
- #68 \n
- #69 https://devcentral.f5.com/weblogs/images/devcentral_f5_com/weblogs/macvittie/WindowsLiveWriter/TheFourEventsoftheDecadethatShapedtheFut_6993/hindsight_2.jpg\n\nJSON from the start (Show demo)\nBuild a client\nA lot of discussions - more of a basis now\nTOO MUCH LINKING ? Focus on resources - perhaps didnt need a link to the &#x201C;entitlements&#x201D; in order to query, could just send to the USER object\n\n
- #70 \n