Hypermedia For Y'All - Speaker Deck

Slide 1

Slide 1 text

Roar! Nick „The German“ Sutterer @apotonick Hypermedia for y'all! The Missing Ingredient in REST

Slide 2

Slide 2 text

2 Roar! 43.8 minutes... REST Representations Hypermedia Roooaaar

Slide 3

Slide 3 text

3 Roar! REST?

Slide 4

Slide 4 text

4 Roar! „architectural style for distributed hypermedia systems“ Roy Fielding's dissertation, chapter 5, line 1

Slide 5

Slide 5 text

5 Roar! require 'rest' class Application include Restful end

Slide 6

Slide 6 text

6 Roar! GET http://nick/state {„status“ : „sober“}

Slide 7

Slide 7 text

Roar! Resource Unique URL http://beer/rocky Uniform Interface GET POST PUT ... Represen- tation

Slide 8

Slide 8 text

Roar! „REST“ monolithic app pretty URLs GET renders models (JSON/HTML) POST to create and update models

Slide 9

Slide 9 text

Roar! Mono- lithic Systems

Slide 10

Slide 10 text

Roar! componentized app ...still pretty URLs real REST services with GET, PUT, POST, DELETE no HTML! embedded hypermedia REST

Slide 11

Slide 11 text

Roar! Split it!

Slide 12

Slide 12 text

Roar! BURP! Order!

Slide 13

Slide 13 text

Roar! BURP! Beer shop system Using RESTful backend services and a separate Presentation layer !

Slide 14

Slide 14 text

Roar! A typical REST session!

Slide 15

Slide 15 text

Roar! GET/PUT/ http://... ------------------- -------------------

Slide 16

Slide 16 text

Roar! GET http://beers/1 name: Rocky alc : 6.0

Slide 17

Slide 17 text

Roar! POST http://beers/ ------------------- name: Beck's alc : 5.1 Created! It's at http://beers/becks

Slide 18

Slide 18 text

18 Roar! GET: show POST: create PUT: update ... REST is

Slide 19

Slide 19 text

19 Roar! CRUD is not REST!

Slide 20

Slide 20 text

Roar! A hypermedia- driven REST session!

Slide 21

Slide 21 text

Roar! BURP! Order!

Slide 22

Slide 22 text

Roar! BURP! REST Service Client

Slide 23

Slide 23 text

23 Roar! BURP!

Slide 24

Slide 24 text

24 Roar! BURP!

Slide 25

Slide 25 text

Roar! GET http://orders/1 id: 1 created_at: August 30 to proceed: http://orders/1/pay to update: http://orders/1

Slide 26

Slide 26 text

Roar! to proceed: http://orders/1/pay to update: http://orders/1 „ HATEOAS“ WTF?

Slide 27

Slide 27 text

Roar! „HATEOAS“ - embedd actions that make sense in current application state

Slide 28

Slide 28 text

Roar! {order: { id : 1 created_at: August 31 links : [ {rel : proceed href: http://orders/1/pay} {rel : self href: http://orders/1} ] } Hypermedia & JSON

Slide 29

Slide 29 text

Roar! rel : proceed href: http://orders/1/pay

Slide 30

Slide 30 text

30 Roar!

Slide 31

Slide 31 text

Roar! rel – link semantic, „meaning“ href – resource URL

Slide 32

Slide 32 text

Roar! Creating a new order

Slide 33

Slide 33 text

Roar! POST http://orders ------------------------ client_id: 42 id : 1 client_id: 42 beers : [] links : [ {rel : self href: http://orders/1} {rel : beers href: http://orders/1/be ]

Slide 34

Slide 34 text

Roar! Single entry point – the one and only URL we know POST http://orders ------------------------ client_id: 42

Slide 35

Slide 35 text

Roar! id : 1 client_id: 42 beers : [] links : [ {rel: self href: http://orders/1} {rel: beers href: http://orders/1/beers} ] self link – pointing to current resource

Slide 36

Slide 36 text

Roar! id : 1 client_id: 42 beers : [] links : [ {rel: self href: http://orders/1} {rel: beers href: http://orders/1/beers} ] beers link – items placed in order

Slide 37

Slide 37 text

Roar! GET the new order

Slide 38

Slide 38 text

Roar! GET http://orders/1 id : 1 client_id: 42 beers : [] links : [ {rel : self href: http://orders/1} {rel : beers href: http://orders/1/be ]

Slide 39

Slide 39 text

Roar! Follow the beers link

Slide 40

Slide 40 text

Roar! GET http://orders/1/beers beers: [] links: [ {rel : self href: http://orders/1/be {rel : order href: http://orders/1}

Slide 41

Slide 41 text

Roar! Add beer to order

Slide 42

Slide 42 text

Roar! POST http://orders/1/beers ------------------------ {name: Anchor Steam} Created! It's at http://orders/1/beers/anchors team Created! It's at http://orders/1/beers/anchors team

Slide 43

Slide 43 text

Roar! Reloading the order

Slide 44

Slide 44 text

Roar! GET http://orders/1 id : 1 client_id: 42 beers: [ {name: Anchor Steam links: [ {rel : self href: http://orders/1/ ]} ],

Slide 45

Slide 45 text

Roar! id : 1 client_id: 42 beers: [ {name: Anchor Steam links: [ {rel : self href: http://orders/1/beers/anchorsteam} ]} ], links: [ {rel: self href: http://orders/1} {rel: beers href: http://orders/1/beers} ] +

Slide 46

Slide 46 text

Slide 47

Slide 47 text

Roar! +

Slide 48

Slide 48 text

Roar! Removing beer from order

Slide 49

Slide 49 text

Roar! DELETE http://orders/1/beers/anchorsteam +

Slide 50

Slide 50 text

Roar! Reloading the order

Slide 51

Slide 51 text

Roar! GET http://orders/1 id : 1 client_id: 42 beers : [] links : [ {rel : self href: http://orders/1} {rel : beers href: http://orders/1/be ]

Slide 52

Slide 52 text

Roar! GET http://orders/1 id : 1 client_id: 42 beers : [] links : [ {rel : self href: http://orders/1} {rel : beers href: http://orders/1/be ]

Slide 53

Slide 53 text

53 Roar! http://orders/ POST GET GET + DELETE ? GET POST

Slide 54

Slide 54 text

54 Roar! What we didn't do... PUT http://orders/1 DELETE http://orders/1/items ...

Slide 55

Slide 55 text

55 Roar! Code!

Slide 56

Slide 56 text

Roar! Roar!

Slide 57

Slide 57 text

gem 'roar'

Slide 58

Slide 58 text

58 Roar! class Beer include Roar::Representer::JSON property :name property :id link :self do beer_url(id) end Plain properties Hypermedia support yo

Slide 59

Slide 59 text

59 Roar! Beer.new(:id => 1, :name => "NickBrew").to_json from Roar {"beer":{ "id" : 1, "name" : "NickBrew", "links": [{"rel":"self","href":"http://beers/1"}]}}

Slide 60

Slide 60 text

60 Roar! brew = Beer.from_json '{"beer":{ "id" : 1, "name" : "NickBrew"}}' from Roar brew.name #=> „NickBrew“

Slide 61

Slide 61 text

61 Roar! class Beer include Roar::Representer::XML ... jaja brew.to_xml 1 NickBrew

Slide 62

Slide 62 text

62 Roar! class Order include Roar::Representer::JSON collection Beer

Slide 63

Slide 63 text

63 Roar! class Collection include Roar::Representer::JSON link :next do page_url(page) end end class Beers < Collection collection Beer

Slide 64

Slide 64 text

64 Roar! brew.new(:name => „SKOL“) brew.new(:name => „SKOL“) brew.extend Feature::HTTPVerbs brew.new(:name => „SKOL“) brew.extend Feature::HTTPVerbs brew.post!(„http://beers“) brew.new(:name => „SKOL“) brew.extend Feature::HTTPVerbs brew.post!(„http://beers“) puts „I'm at“ + brew.links[:self] #=> „http://beers/99“

Slide 65

Slide 65 text

65 Roar!

Slide 66

Slide 66 text

66 Roar! „REST APIs must be hypertext-driven“: http://roy.gbiv.com/untangled/2008/rest-apis-must-be- hypertext-driven REST in Practice – O'REILLY RESTful Web Services Cookbook – O'REILLY