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
2
510

Hypermedia APIs with Webmachine and ROAR

Building hypermedia APIs with Webmachine and ROAR

Avatar for Larry Staton Jr.

Larry Staton Jr.

November 15, 2012
Tweet

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
520
A Tale of Two Teams
Avatar for Larry Staton Jr. statonjr
0
52
Hypermedia with Transit
Avatar for Larry Staton Jr. statonjr
0
75
Hazel & Keyboard Maestro: A Perfect Mac Marriage
Avatar for Larry Staton Jr. statonjr
1
690
Zooming Out
Avatar for Larry Staton Jr. statonjr
0
60
HTTP 101
Avatar for Larry Staton Jr. statonjr
1
270
PUT /time
Avatar for Larry Staton Jr. statonjr
1
75

Other Decks in Technology

See All in Technology
GCASアップデート（202506-202508）
Avatar for 高橋広和 techniczna
0
180
プロダクトエンジニアリングで開発の楽しさを拡張する話
Avatar for sagawa / barometrica barometrica
0
210
Autonomous Database Serverless 技術詳細 / adb-s_technical_detail_jp
Avatar for oracle4engineer oracle4engineer
PRO
18
52k
生成AI活用のROI、どう測る？ DMM.com 開発責任者から学ぶ「AI効果検証のノウハウ」 / ROI of AI
Avatar for Masato Ishigaki / 石垣雅人 i35_267
3
120
[OCI Technical Deep Dive] OCIで生成AIを活用するためのソリューション解説(2025年8月5日開催)
Avatar for oracle4engineer oracle4engineer
PRO
0
120
AI関数が早くなったので試してみよう
Avatar for kumakura koki kumakura
0
330
オブザーバビリティ文化を組織に浸透させるには / install observability culture
Avatar for mackerelio mackerelio
0
160
Cloud WANの基礎から応用～少しだけDeep Dive～
Avatar for モブエンジニア（Masaki Okuda） masakiokuda
3
120
自治体職員がガバクラの AWS 閉域ネットワークを理解するのにやって良かった個人検証環境
Avatar for Ushida takeda_h
0
270
20250807_Kiroと私の反省会
Avatar for Rika.I riz3f7
0
260
AIが住民向けコンシェルジュに？ Amazon Connectと生成AIで実現する自治体AIエージェント！
Avatar for yuyeah yuyeah
0
180
Kiro と Q Dev で 同じゲームを作らせてみた
Avatar for r3_yamauchi r3_yamauchi
PRO
1
120

Featured

See All Featured
Adopting Sorbet at Scale
Avatar for Ufuk Kayserilioglu ufuk
77
9.5k
The Web Performance Landscape in 2024 [PerfNow 2024]
Avatar for Tammy Everts tammyeverts
9
770
Code Review Best Practice
Avatar for Trisha Gee trishagee
69
19k
JavaScript: Past, Present, and Future - NDC Porto 2020
Avatar for David Neal reverentgeek
50
5.5k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
Avatar for Eileen M. Uchitelle eileencodes
36
2.5k
Keith and Marios Guide to Fast Websites
Avatar for Keith Pitt keithpitt
411
22k
Product Roadmaps are Hard
Avatar for C. Todd Lombardo iamctodd
PRO
54
11k
Embracing the Ebb and Flow
Avatar for Simon Collison colly
86
4.8k
Art, The Web, and Tiny UX
Avatar for Lynn Fisher lynnandtonic
301
21k
Producing Creativity
Avatar for Steve Smith orderedlist
PRO
347
40k
Into the Great Unknown - MozCon
Avatar for Noah Learner thekraken
40
2k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
Avatar for Addy Osmani addyosmani
7
810

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