Building well-defined APIs part 1: Proper HTTP

Short intro to Ruby port of Webmachine.

Transcript

1. Proper HTTP Building well-defined APIs, part 1: @neektza Nikica Jokić
2. HTTP is deceptively simple
3. • simple syntax, semantics up to you HTTP is deceptively simple
4. • simple syntax, semantics up to you • easy to build crappy, bad-behaving APIs HTTP is deceptively simple
5. • simple syntax, semantics up to you • easy to build crappy, bad-behaving APIs • use error status codes HTTP is deceptively simple
6. • simple syntax, semantics up to you • easy to build crappy, bad-behaving APIs • use error status codes • respect content-types (accept headers) HTTP is deceptively simple
7. • simple syntax, semantics up to you • easy to build crappy, bad-behaving APIs • use error status codes • respect content-types (accept headers) • handle resource migration and locations HTTP is deceptively simple
8. A huge SVG! http://for-get.github.io/http-decision-diagram/httpdd.fsm.html
9. Webmachine (1/2)
10. • Not a framework - a toolkit Webmachine (1/2)
11. • Not a framework - a toolkit • Implements the HTTP protocol as a state-machine Webmachine (1/2)
12. • Not a framework - a toolkit • Implements the HTTP protocol as a state-machine Webmachine (1/2)
13. • Not a framework - a toolkit • Implements the HTTP protocol as a state-machine Webmachine (1/2)
14. • Not a framework - a toolkit • Implements the HTTP protocol as a state-machine • Several implementations: Webmachine (1/2)
15. • Not a framework - a toolkit • Implements the HTTP protocol as a state-machine • Several implementations: • Webmachine (1st Erlang, then Ruby) Webmachine (1/2)
16. • Not a framework - a toolkit • Implements the HTTP protocol as a state-machine • Several implementations: • Webmachine (1st Erlang, then Ruby) • Liberator (Clojure) Webmachine (1/2)
17. • Not a framework - a toolkit • Implements the HTTP protocol as a state-machine • Several implementations: • Webmachine (1st Erlang, then Ruby) • Liberator (Clojure) • others? Webmachine (1/2)
18. A huge SVG! Again! http://for-get.github.io/http-decision-diagram/httpdd.fsm.html
19. Webmachine (2/2)
20. • Declarative Webmachine (2/2)
21. • Declarative Webmachine (2/2) get '/hello/:name' do "Hello #{params[:name]}!" end
22. • Declarative • Works by describing facts about the resource Webmachine (2/2) get '/hello/:name' do "Hello #{params[:name]}!" end
23. • Declarative • Works by describing facts about the resource Webmachine (2/2) get '/hello/:name' do "Hello #{params[:name]}!" end def resource_exists? resource end
24. • Declarative • Works by describing facts about the resource Webmachine (2/2) get '/hello/:name' do "Hello #{params[:name]}!" end def resource_exists? resource end • known-method? / method-allowed ? • known-media-type? / media-type-available? • allowed? / authorised? • exists? / existed? • moved-temporarily? / moved-permanently?