Application developers are the customers of your API. Success is measured by how quickly those developers enjoy success using your API in their applications. And rapid adoption of an API by your internal, partner, or external developers is all about design. Building upon their prior work in API design, Marsh Gardiner and Brian Mulloy unveil RV, a style of API design that embraces developer adoption as its guiding principle. They explore the constraints and opportunities introduced by RV and discuss RV's place in the context of other design approaches like REST and Hypermedia. See the youtube video of this webcast https://www.youtube.com/watch?v=u-bGz9HQIuo

1. API Design
Brian Mulloy
@landlessness
Marsh Gardiner
@earth2marsh
An Adoption-Centered Approach

2. @landlessness
Brian Mulloy
@earth2marsh
Marsh Gardiner

3. http://iloveapis2014.com

4. groups.google.com/group/api-craft

5. youtube.com/apigee

6. slideshare.net/apigee

7. Integers as a Service

8. Overview
• How did we get here?
• Where are we now?
• Where are we going?
• How are we going to get there?
• Questions

9. How did we get here?

10. In the beginning…

11. SOAP and XML-RPC

12. REST

13. The rise of…
• Software as a Service
• Web Mashups
• Virtualization
• User Experience
• Mobile

14. Web vs App

15. Technology unlocks technology…

16. Gehry vs Winnebago
photo: uggb

17. Where are we now?

18. Refocusing API design

19. Passion (and controversy)

21. API Craft Conference
http://api-craft.org
Monday, July 28th – Wednesday July 30th

22. Hypermedia Panel
API Craft Conference - http://api-craft.org
• Collection+JSON
–Mike Amundsen
• Hydra
–Markus Lanthaler
• Mason
–Jørn Wildt
• HAL
–Mike Kelly
• JSON API
–Steve Klabnik
• Siren
–Kevin Swiber

24. Gehry vs Winnebago
photo: uggb

25. Designing for adoption

26. Resource
(a thing that lives somewhere)
26
IP: 173.194.70.102 ➡ google.com
Twitter: 14352786 ➡ @earth2marsh
https://github.com/apigee

27. Verb

28. Applying RV patterns

29. Collections and entities
https://api.stripe.com/
Summary of Resource URL Patterns
/v1/charges
/v1/charges/{CHARGE_ID}
/v1/coupons
/v1/coupons/{COUPON_ID}
/v1/customers
/v1/customers/{CUSTOMER_ID}

30. Versions
/2010-04-01/Accounts/
Twilio
/services/data/v29.0/sobjects/Account
Salesforce
/v2/users
Foursquare

31. Query Parameters
/1.1/search/tweets.json?q=%23superbowl
&result_type=recent
Twitter

32. Header Parameters

33. Conveniences
/me
Facebook
/v1/people/~
LinkedIn
/v2/checkins/recent
Foursquare

34. Formats
/users/3207.json
SoundCloud
/users/3207

35. Formats

36. Actions
/search?q=watermelon&type=post
Facebook
/convert?from=EUR&to=CNY&amount=100
(hypothetical)
/droplets/{droplet_id}/reboot
DigitalOcean

37. Authentication

38. Dates
"created_at": "Thu Nov 03 05:19:38
+0000 2011"
Twitter
"DateTime": "2011-10-29T09:35:00Z"
Bing
"createdAt": 1320296464
Foursquare

39. Filters
/me?fields=name,birthday,photos.limit(10)
.fields(id,picture),videos.type(tagged)
.limit(10).fields(id, source)
Facebook

40. offset, limit
Facebook
page, rpp
Twitter
start, count
LinkedIn
Pagination

41. Pagination
offset, limit
Facebook

42. HATEOAS and the Hypermedia Constraint

43. Hypermedia

44. Great moments in
mishandled error code history

45. Errors

46. SDKs

47. Perfect is the enemy of done

49. General philosophy

50. Questions
rv@apigee.com, @ResourceVerb
brian@apigee.com, @landlessness
marsh@apigee.com, @earth2marsh

51. THANK YOU
Brian Mulloy
@landlessness
Marsh Gardiner
@earth2marsh

52. THANK YOU
Subscribe to webcasts at:
youtube.com/apigee

53. THANK YOU
Questions and ideas to:
groups.google.com/group/api-craft

54. THANK YOU
Webcast slides at:
slideshare.net/apigee

55. THANK YOU
Brian Mulloy
@landlessness
Marsh Gardiner
@earth2marsh