Api Design and More (Friday Training at Itnig)
•
2 likes•948 views
Friday Training by Jordi Romero about the challenges of creating an API for Teambox
Recommended
More Related Content
Similar to Api Design and More (Friday Training at Itnig)
Similar to Api Design and More (Friday Training at Itnig) (20)
More from itnig
More from itnig (20)
Recently uploaded
Recently uploaded (20)
Api Design and More (Friday Training at Itnig)
- 5. API
- 8. web API REST
- 9. we want APIs that are easy to understand, consume, extend and scale
- 10. design API implementation deployment scaling
- 11. design API implementation deployment scaling retirement
- 12. design SCA LE R EAL API implementation deployment scaling
- 14. alternative throw v1 as soon as you finish it
- 15. design API implementation deployment scaling
- 16. HTTP REST URI METHODS STATUS METADATA REPRESENTATION SECURITY VERSIONING PAGINATION
- 17. HTTP HyperText Transfer Protocol - OSI lvl 7 learn to love it use proper URIs, methods, status codes, request and response headers, ...
- 18. REST REpresentational State Transfer Resources are first class citizens Resources have unique representations Communication is stateless
- 20. URIs are resource identifiers not just a path to a server action
- 22. BAD URIs http://toster.ru/posts/ http://toster.ru/posts/first_post trailing slash underscore http://toster.ru/posts/Hello upper case http://toster.ru/posts.json file extension
- 24. GOOD URIs http://toster.ru/blogs/jordi/posts/api-design http://toster.ru/blogs/jordi/posts http://toster.ru/blogs/jordi http://toster.ru/blogs hierarchical resource identifier I see what you did there
- 25. HTTP methods GET POST PUT DELETE HEAD PATCH ... Also called “Verbs” Together with a URI they tell the API what to do
- 26. GET retrieve a resource representation HEAD get only the headers, no body PUT update a resource POST create a resource, execute controllers DELETE remove a resource PATCH partially update a resource more...
- 27. Response statuses 1xx 2xx 3xx 4xx 5xx Do not limit to 200, 404 and 500 RTFM Specifications
- 28. Metadata Useful req/res information in the headers Content-Type Cache-Control Content-Length Expires Last-Modified Date Etag Pragma Location Custom, ...
- 29. Metadata Useful req/res information in the headers Content-Type Cache-Control Content-Length Expires ER LAT AT Date Last-Modified E ON TH Etag M OR Pragma Location Custom, ...
- 30. Security Protect private resources OAuth is the most common option right now Basic HTTP Authentication also works SSL is not optional
- 31. Versioning APIs should evolve without breaking example.com/api/v3/posts BAD v3.api.example.com/posts OK Accept: application/vnd.example.v3+json GOOD
- 32. Pagination Return a partial collection example.com/posts/pages/2 BAD example.com/posts?page=2&per_page=20 GOOD
- 33. design API implementation deployment scaling
- 34. code!
- 36. Ruby on Rails Sinatra — Ruby express — node.js ∞ options...
- 37. abstract the backing services as much as possible
- 38. do only what’s critical while building a response. everything else must be async
- 39. design API implementation deployment scaling
- 40. stateless processes any process is good Sessions can go to Redis, Memcached, ... State must go on stateful processes (database)
- 41. disposable processes license to kill’em Processes being stateless and disposable, it’s easy to avoid memory bloat and scale out
- 42. structured processes app servers, workers, web servers, ... It’s important to separate processes by their primary task
- 43. design API implementation deployment scaling
- 44. horizontal scaling is inexpensive If more load can be handled by more processes
- 45. horizontal scaling is inexpensive not really If more load can be handled by more processes: it scales!
- 46. application caching don’t do things twice Never calculate things twice. Do it once, store it. Redis, Memcached, I’m looking at you.
- 47. HTTP caching save bandwidth, cut response time Use HTTP headers to define the response’s cacheability, expiration, validity, ... Take advantage of Varnish, Squid, ...
- 48. database replication faster reads is a big win If your API serves more reads than writes, send the reads to read-only slaves of the database
- 49. delay async tasks response time is everything If you didn’t before, do it now
- 50. design API implementation deployment scaling
- 52. thank you
- 55. Jordi Romero follow @jordiromero follow @itnig