PUTTING THE MEDIA IN HYPERMEDIA

Erik Michaels-Ober, Developer Evangelist @ SoundCloud
Session: Media, Music and Audio APIs
API Strategy & Practice Conference, Amsterdam 2014

Transcript

1. PUTTING THE
 MEDIA
 IN HYPERMEDIA
5. REST vs. SOAP
6. SOAP APIs NEVER DIE,
 THEY JUST FADE AWAY
14. SOAP vs. REST SOAP GET /api.xml?action=getUser&id=1
15. SOAP vs. REST SOAP GET /api.xml?action=getUser&id=1
16. SOAP vs. REST SOAP GET /api.xml?action=getUser&id=1
17. SOAP vs. REST SOAP GET /api.xml?action=getUser&id=1 REST GET /users/1.json
18. SOAP vs. REST SOAP GET /api.xml?action=getUser&id=1 REST GET /users/1.json
19. SOAP vs. REST SOAP GET /api.xml?action=getUser&id=1 REST GET /users/1.json
20. SOAP vs. REST SOAP GET /api.xml?action=getUser&id=1 REST GET /users/1.json
21. FILE NAME EXTENSIONS
23. RESOURCE VS. REPRESENTATION
24. XML REPRESENTATION GET /users/1.xml
 
 <user>
 <id>1</id>
 <name>Erik</name>
 </user>
25. JSON REPRESENTATION GET /users/1.json
 
 {
 “id”: 1,
 “name”: “Erik”
 }
26. RESOURCE VS. REPRESENTATION GET /users/1.xml GET /users/1.json
27. RESOURCE VS. REPRESENTATION GET /users/1
28. ACCEPT HEADER The Accept request-header field can be used to specify certain media types which are acceptable for the response.
29. ACCEPT HEADER GET /avatars/1.png
 
 Accept: image/png
30. ACCEPT HEADER GET /avatars/1
 
 Accept: image/png,
 image/jpeg; q=0.8,
 image/gif; q=0.8,
 image/*; q=0.5,
 application/json; q=0.1
31. ACCEPT HEADER GET /avatars/1
 
 Accept: video/*,
 image/gif; q=0.8,
 image/*; q=0.5,
 application/json; q=0.1
33. FORMATS CHANGE
34. FIELDING ON REST REST is software design on the scale of decades: every detail is intended to promote software longevity and independent evolution. Many of the constraints are directly opposed to short-term efficiency. Unfortunately, people are fairly good at short-term design, and usually awful at long- term design. Most don’t think they need to design past the current release.
35. EXPOSE RESOURCES,
 NOT REPRESENTATIONS
36. THANK YOU
 @sferik
 @SoundCloudDev