ReSTful web services via RFC-2616

Transcript

1. PROJECT DATE CLIENT 2012-06-12 ROBERT ALLEN / @ZIRCOTE RESTFUL WEB

   SERVICES VIA RFC-2616 API-CRAFT CHICAGO MEETUP Text SSID: IFBYPHONE_GUEST PASSWD: IFBYPHONE Tuesday, June 12, 12

2. NETFLIX CONSUMER API REQUESTS NETFLIX API GROWTH JANUARY 2010...APRIL 2011

   Tuesday, June 12, 12

3. YOUTUBE ORGANIC GROWTH Tuesday, June 12, 12

4. FACEBOOK APPLICATION INTEGRATION Tuesday, June 12, 12

5. IFBYPHONE TECHNOLOGY EVOLUTION Tuesday, June 12, 12

6. Web Services Tuesday, June 12, 12

7. XML-RPC Invented 1998 Patented in 2006 Four times the bytes

   as xml Effectively ReST in practice Tuesday, June 12, 12

8. SOAP Control freaks dream. Transport agnostic WSDL, UDDI, WS-*, MTOM,

   1.1, 1.2 Tuesday, June 12, 12

9. Representation State Transfer Tuesday, June 12, 12

10. So, what is ReST? Tuesday, June 12, 12

11. It’s not... a standard a requirement always pretty always sane

    agreed upon by more than 2 people in a room of 20. Tuesday, June 12, 12

12. It is... an architectural guideline very flexible or rigid as

    simple or complex as you make it a living technology the culmination of previous works into a single suggested tool chest. Tuesday, June 12, 12

13. Roy Thomas Fielding. Dissertation: “Architectural Styles and the Design of

    Network- based Software Architectures” Principal Author of RFC-2608, RFC-2616, RFC-2396, RFC-1808, RFC-2145 and RFC-1945 “Life is a distributed object system. However, communication among humans is a distributed hypermedia system, where the minds intellect, the voice +gestures, eyes+ears, and imagination are all components. -- Roy T. Fielding 1998 Tuesday, June 12, 12

14. RFC-1808 (June 1995) Relative URL RFC-1945 (May 1996) HTTP 1.0

    RFC-2068 (January 1997) HTTP 1.1 RFC-2145 (May 1997) HTTP Version Numbers RFC-2396 (August 1998) Uniform Resource Identifiers RFC-2616 (June 1999) HTTP 1.1 Architectural Styles and the Design of Network-based Software Architectures. (2000) Tuesday, June 12, 12

15. THE FIELDING LEGACY Tuesday, June 12, 12

16. So what is RFC-2616? Tuesday, June 12, 12

17. Methods Headers Status Codes Content Negotiation Security Considerations Connection Handling

    and Parameters Caching Tuesday, June 12, 12

18. GET Tuesday, June 12, 12

19. resource?query_string Tuesday, June 12, 12

20. Lucene/Solr Tuesday, June 12, 12

21. Google Query Language Tuesday, June 12, 12

22. Riak Tuesday, June 12, 12

23. POST/PUT Tuesday, June 12, 12

24. Create and Modify raw body (xml, text, json...) multipart/form-data x-www-form-

    urlencoded Tuesday, June 12, 12

25. DELETE/HEAD/TRACE Tuesday, June 12, 12

26. Headers Tuesday, June 12, 12

27. Request & Response Tuesday, June 12, 12

28. Standard & User Defined Tuesday, June 12, 12

29. User Defined Headers User defined headers must begin with ‘X-’

    X-FORWARDED-FOR Tuesday, June 12, 12

30. Content-Type resource.json resource.xml resource.csv resource.pdf Tuesday, June 12, 12

31. resource.json resource.xml resource.csv resource.pdf Tuesday, June 12, 12

32. resource.json resource.xml resource.csv resource.pdf Tuesday, June 12, 12

33. Accept resource.json resource.xml resource.csv resource.pdf Tuesday, June 12, 12

34. resource.en-us resource.en-uk resource.es-mx resources.fr-ca Tuesday, June 12, 12

35. resource.en-us resource.en-uk resource.es-mx resources.fr-ca Tuesday, June 12, 12

36. Accept-Language resource.en-us resource.en-uk resource.es-mx resources.fr-ca Tuesday, June 12, 12

37. Accept: application/json Tuesday, June 12, 12

38. Accept-Language: en-us Tuesday, June 12, 12

39. Accept-Charset: iso-8859-5 Tuesday, June 12, 12

40. Functional Uses of Headers Tuesday, June 12, 12

41. Pagination: Range: items 1-20 Content-Range: items 1-20/200 206 Partial Content

    Tuesday, June 12, 12

42. E-Tag If-None-Match If-Match Idempotency & Caching Tuesday, June 12, 12

43. Content Negotiation Accept: application/json, application/xml, application/ json+hal;q=0.9,*/*;q=0.8 Tuesday, June 12,

    12

44. Rate Limiting X-RateLimit-Limit X-RateLimit-Remaining X-RateLimit-Reset 420 Enhance Your Calm (courtesy

    of Twitter) Tuesday, June 12, 12

45. Dysfunctional Uses of Headers Tuesday, June 12, 12

46. always sending a 200 regardless of state sending E-Tags but

    not using them assignment of errors to incorrect status advertising Content-Negotiation but failing to honor it. Tuesday, June 12, 12

47. Status Codes & Error Handling Tuesday, June 12, 12

48. Classification Groups 100 Informational 200 Successful 300 Redirection 400 Client

    Error 500 Server Error Tuesday, June 12, 12

49. 418 I’m a teapot RFC-2324 HTCPCP 1.0 coffee-scheme://host/ pot_designator? additions

    Tuesday, June 12, 12

50. Other Status Code Considerations Not all user agents are friendly.

    Don’t be an unfriendly agent. not all 200s are created equal. Tuesday, June 12, 12

51. COMMITMENT Tuesday, June 12, 12

52. REST IS A LIVING INTERPRETATION EVOLVING DAILY Tuesday, June 12,

    12

53. Want to Know More? www.ietf.org www.ics.uci.edu/~fielding www.zircote.com scholar.google.com => Roy

    Fielding groups.google.com => Api-Craft Tuesday, June 12, 12