REST API Design - My Practices

Android Developer Days 2015
View Video (Starts from 19.00) >> http://www.butterflytv.net/player.html?videoId=from_pi44461431134246344

Transcript

1. GET REST. API/MY_Practices 1
2. Burak AYDIN 4pps | burak@4pps.co Gdg Ankara @burakaydn 2
3. REST REpresentational State Transfer is a architectural style for distributed hypermedia systems. 3
4. REST • Client-server • Stateless state of the resource • Cacheable • Layered system load balancing, cache, etc. • Uniform interface guiding principles 4
5. REST Guiding Principles •Identification of resources URIs •Manipulation of resources through these representations representation and it's metadata = enough information to manipulate it •Self-descriptive messages each message = enough information to process it (MIME, cache, ...) •Hypermedia as the engine of application state 5
6. Glory of REST (Leonard Richardson's Maturity Model) 1. “The Swamp of POX” You’re using HTTP to make RPC calls. HTTP is only really used as a tunnel. 2. Resources Rather than making every call to a service endpoint, you have multiple endpoints that are used to represent resources, and you’re talking to them. 3. HTTP verbs You interact with resources using HTTP verbs, rather than always using POST. 4. HATEOAS Hypermedia Controls. HATEOAS. You’re 100% REST compliant. 6
7. HATEOS Hypertext As The Engine Of Application State ▪ Used to find your way through the API ▪ Actually telling us what is allowed and what not 7
8. ▪ Resource addressed by URI ▪ URI Templates ▪ HTTP based interactions CRUD API 8
9. POST /groups.discuss. replies.edit POST /photos.delete 9
10. POST /groups.discuss. replies.edit POST /photos.delete 10
11. http://example.org/api/v1/product/123 http://example. org/api/v1/products/123? includes=comments 11
12. “ GET should not ALTER the STATE GET /subscriptions/171/cancel PUT /subscriptions/171/cancel 12
13. Authorization ▪ Basic Authorization over SSL ▪ OAuth ▪ OAuth2 13
14. Pagination https://api.github.com/user/repos? page=2&per_page=100 ▪ Link Header #rfc5988 meta: [ link:{ href:"/products/?page=3", rel:"next" } ] 14
15. HTTP Caching ▪ ETag ▪ Last-Modified ▪ Cache-Control ▪ Expires mnot.net/cache_docs/ 15
16. Postman Supercharge API workflow getpostman.com 16
17. Other titles ▪ HTTP Status codes ▪ Rate limiting ▪ Error handling 17
18. 18 Tesekkürler! Sorular? burakaydin.net.tr @burakaydn burak@4pps.co
19. Kaynaklar ▪ http://restcookbook.com/ ▪ https://en.wikipedia.org/wiki/Representational_state_transfer ▪ https://speakerdeck.com/robsondealmeida/r-dot-i-p-dot-rest-in-peace- a-guide-through-restful-services ▪ https://speakerdeck.com/honzajavorek/rest-api-manual ▪ https://developer.github.com/v3/#pagination ▪ https://speakerdeck.com/josephruscio/building-restful-apis 19