Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Hypermedia APIs with Webmachine and ROAR

Avatar for Larry Staton Jr. Larry Staton Jr.
November 15, 2012
Technology
550
2

Hypermedia APIs with Webmachine and ROAR

Building hypermedia APIs with Webmachine and ROAR

Avatar for Larry Staton Jr.

Larry Staton Jr.

November 15, 2012

More Decks by Larry Staton Jr.

See All by Larry Staton Jr.
Object-Oriented Programming Basics with Smalltalk
Avatar for Larry Staton Jr. statonjr
0
570
A Tale of Two Teams
Avatar for Larry Staton Jr. statonjr
0
63
Hypermedia with Transit
Avatar for Larry Staton Jr. statonjr
0
92
Hazel & Keyboard Maestro: A Perfect Mac Marriage
Avatar for Larry Staton Jr. statonjr
1
700
Zooming Out
Avatar for Larry Staton Jr. statonjr
0
74
HTTP 101
Avatar for Larry Staton Jr. statonjr
1
300
PUT /time
Avatar for Larry Staton Jr. statonjr
1
88

Other Decks in Technology

See All in Technology
Sets in Go
Avatar for Luciano Ramalho ramalho
1
520
その“隠したつもり”が命取り ── 自前と平文をやめて「正解」に委ねる
Avatar for kuroneko kuroneko13
0
120
LLM・AIエージェントシステムベストプラクティス
Avatar for shibuiwilliam shibuiwilliam
6
1.2k
PLATEAU で バーチャル花火大会
Avatar for tatsuya1970 tatsuya1970
0
150
Webアクセシビリティ入門 2026
Avatar for Recruit recruitengineers
PRO
3
560
猫付きpingコマンドを自作
Avatar for uyuki uyuki234
0
230
攻撃と防御で学ぶAI時代のプロダクトセキュリティ演習
Avatar for Recruit recruitengineers
PRO
9
2.8k
【CEDEC2026】Creative Approaches to Localizing the Dialects and Unique Speech of Umamusume: Pretty Derby Characters in English
Avatar for Cygames, Inc. cygames
PRO
3
17k
私がブラウザを自作したくなった理由
Avatar for Miyamoto Naoyuki supurazako
1
230
カートの信頼性を担保するWireMockを使ったe2eテスト
Avatar for ykagano ykagano
0
260
FPGAが実現する遠方宇宙の高空間分解能天体撮影 -大型地上望遠鏡の視力を補正する「補償光学」とは？-
Avatar for 高橋光明 / Mitsuaki Takahashi komei_mt
0
240
JavaScript 研修 (2026)
Avatar for Recruit recruitengineers
PRO
2
540

Featured

See All Featured
Amusing Abliteration
Avatar for ianozsvald ianozsvald
1
240
ラッコキーワード サービス紹介資料
Avatar for ラッコ株式会社 rakko
1
4.3M
Joys of Absence: A Defence of Solitary Play
Avatar for Sebastian Deterding codingconduct
1
430
The Illustrated Guide to Node.js - THAT Conference 2024
Avatar for David Neal reverentgeek
1
430
Art, The Web, and Tiny UX
Avatar for Lynn Fisher lynnandtonic
304
22k
Jess Joyce - The Pitfalls of Following Frameworks
Avatar for Tech SEO Connect techseoconnect
PRO
1
370
Avoiding the “Bad Training, Faster” Trap in the Age of AI
Avatar for Mike Taylor tmiket
0
200
The Language of Interfaces
Avatar for Des Traynor destraynor
162
27k
Faster Mobile Websites
Avatar for Dean Hume deanohume
310
32k
Build The Right Thing And Hit Your Dates
Avatar for Maggie C. maggiecrowley
39
3.4k
Tell your own story through comics
Avatar for letsgokoyo letsgokoyo
1
1k
WENDY [Excerpt]
Avatar for Tessa Abrams tessaabrams
11
39k

Transcript

  1. Hypermedia APIs Hypermedia APIs Webmachine & ROAR 1 Larry Staton

    Jr. : @statonjr 1 Wednesday, 14 November 12

  2. Hypermedia APIs Assumptions 2 2 Wednesday, 14 November 12

  3. Hypermedia APIs REST 3 3 Wednesday, 14 November 12

  4. Hypermedia APIs 4 Constraint Promotes Tradeoff client-server UI Portability Simplified

    server stateless Scalability Reliability Efficiency non-shared caching Reduced latency Efficiency Scalability Reliability uniform interface Independent Evolution Decoupled implementation Efficiency layered system Scalability Simplified clients Higher Latency code-on-demand Extensibility Simplified clients Visibility 4 Wednesday, 14 November 12

  5. Hypermedia APIs 5 Uniform Interface 5 Wednesday, 14 November 12

  6. Hypermedia APIs HTTP 6 6 Wednesday, 14 November 12

  7. Hypermedia APIs 7 Constraint Promotes Tradeoff client-server UI Portability Simplified

    server stateless Scalability Reliability Efficiency non-shared caching Reduced latency Efficiency Scalability Reliability uniform interface Independent Evolution Decoupled implementation Efficiency layered system Scalability Simplified clients Higher Latency code-on-demand Extensibility Simplified clients Visibility 7 Wednesday, 14 November 12

  8. Hypermedia APIs “REST APIs must be hypertext-driven” 8 — Fielding,

    2009! 8 Wednesday, 14 November 12

  9. Hypermedia APIs 9 Richardson Maturity Model 9 Wednesday, 14 November

    12

  10. Hypermedia APIs Hypermedia 10 10 Wednesday, 14 November 12

  11. Hypermedia APIs Media Types 11 11 Wednesday, 14 November 12

  12. Hypermedia APIs 12 Media Type Hypermedia? text/html application/atom+xml application/json application/hal+json

    12 Wednesday, 14 November 12

  13. Hypermedia APIs HTTP 13 13 Wednesday, 14 November 12

  14. Hypermedia APIs 14 14 Wednesday, 14 November 12

  15. Hypermedia APIs Webmachine 15 15 Wednesday, 14 November 12

  16. Hypermedia APIs Resources 16 16 Wednesday, 14 November 12

  17. Hypermedia APIs 17 class HomeResource < Webmachine::Resource def allowed_methods %W[GET]

    end def expires Time.now + 2.weeks end def languages_provided [“en-us”] end end 17 Wednesday, 14 November 12

  18. Hypermedia APIs 18 allow_missing_post? allowed_methods base_uri charsets_provided content_types_accepted content_types_provided create_path

    delete_completed? delete_resource encodings_provided expires finish_request forbidden generate_etag is_authorized? is_conflict? known_content_type? known_methods language_chosen languages_provided last_modified malformed_request? moved_permanently? moved_temporarily? multiple_choices? options post_is_create? previously_existed? process_post resource_exists? service_available? uri_too_long? valid_content_headers? valid_entity_length? validate_content_checksum variances Callbacks 18 Wednesday, 14 November 12

  19. Hypermedia APIs 19 Webmachine::Application.new do |app| app.routes do add [],

    HomeResource end end 19 Wednesday, 14 November 12

  20. Hypermedia APIs Representation 20 20 Wednesday, 14 November 12

  21. Hypermedia APIs HTML 21 21 Wednesday, 14 November 12

  22. Hypermedia APIs 22 <!DOCTYPE html> <html lang=”en”> <body> <a href=”...”

    rel=”../vehicles”>Vehicles</a> </body> </html> Example HTML Representation 22 Wednesday, 14 November 12

  23. Hypermedia APIs 23 class HomeResource < Webmachine::Resource … def content_types_provided

    [[‘text/html’, :to_html]] end def to_html template = Slim::Template.new(“home_representer.slim”) template.render end end 23 Wednesday, 14 November 12

  24. Hypermedia APIs HAL+JSON 24 24 Wednesday, 14 November 12

  25. Hypermedia APIs 25 { “_links”: { “self”: { “href”: “.../api”

    }, “vehicles”: { “href”: “.../vehicles” } } } Example HAL+JSON Representation 25 Wednesday, 14 November 12

  26. Hypermedia APIs ROAR 26 26 Wednesday, 14 November 12

  27. Hypermedia APIs 27 module HomeRepresenter include Roar::Representer::JSON include Roar::Representer::JSON::HAL include

    Roar::Representer::Feature::Hypermedia link :self do "/api" end link :vehicles do ".../vehicles" end end 27 Wednesday, 14 November 12

  28. Hypermedia APIs 28 class HomeResource < Webmachine::Resource … def content_types_provided

    [[‘application/hal+json’, :to_hal]] end def to_hal home = Object.new.extend(HomeRepresenter) home.to_json end end 28 Wednesday, 14 November 12

  29. Hypermedia APIs Next Steps 29 29 Wednesday, 14 November 12

  30. Hypermedia APIs Conclusion 30 30 Wednesday, 14 November 12

  31. Hypermedia APIs Questions? 31 31 Wednesday, 14 November 12

  32. Hypermedia APIs Additional Resources 32 seancribbs/webmachine-ruby apotonick/roar Jon Moore’s 2010

    Oredev talk Steve Klabnik: “Designing Hypermedia APIs” Mike Amundsen: “Building Hypermedia APIs” Webber/Robinson: “REST in Practice” RESTFest 32 Wednesday, 14 November 12