Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Hypermedia APIs with Webmachine and ROAR
Search
Larry Staton Jr.
November 15, 2012
Technology
2
510
Hypermedia APIs with Webmachine and ROAR
Building hypermedia APIs with Webmachine and ROAR
Larry Staton Jr.
November 15, 2012
Tweet
Share
More Decks by Larry Staton Jr.
See All by Larry Staton Jr.
Object-Oriented Programming Basics with Smalltalk
statonjr
0
520
A Tale of Two Teams
statonjr
0
51
Hypermedia with Transit
statonjr
0
75
Hazel & Keyboard Maestro: A Perfect Mac Marriage
statonjr
1
690
Zooming Out
statonjr
0
59
HTTP 101
statonjr
1
260
PUT /time
statonjr
1
75
Other Decks in Technology
See All in Technology
Amazon ECS & AWS Fargate 運用アーキテクチャ2025 / Amazon ECS and AWS Fargate Ops Architecture 2025
iselegant
16
5.4k
Azure AI Foundryでマルチエージェントワークフロー
seosoft
0
180
Welcome to the LLM Club
koic
0
170
米国国防総省のDevSecOpsライフサイクルをAWSのセキュリティサービスとOSSで実現
syoshie
2
1k
How Community Opened Global Doors
hiroramos4
PRO
1
110
より良いプロダクトの開発を目指して - 情報を中心としたプロダクト開発 #phpcon #phpcon2025
bengo4com
1
3.1k
AIエージェント最前線! Amazon Bedrock、Amazon Q、そしてMCPを使いこなそう
minorun365
PRO
13
5k
変化する開発、進化する体系時代に適応するソフトウェアエンジニアの知識と考え方(JaSST'25 Kansai)
mizunori
1
210
急成長を支える基盤作り〜地道な改善からコツコツと〜 #cre_meetup
stefafafan
0
120
2年でここまで成長!AWSで育てたAI Slack botの軌跡
iwamot
PRO
4
690
データプラットフォーム技術におけるメダリオンアーキテクチャという考え方/DataPlatformWithMedallionArchitecture
smdmts
5
620
AWS CDK 実践的アプローチ N選 / aws-cdk-practical-approaches
gotok365
6
720
Featured
See All Featured
What's in a price? How to price your products and services
michaelherold
246
12k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
32
2.3k
Testing 201, or: Great Expectations
jmmastey
42
7.5k
The Cost Of JavaScript in 2023
addyosmani
51
8.4k
What’s in a name? Adding method to the madness
productmarketing
PRO
23
3.5k
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
15
1.5k
The Illustrated Children's Guide to Kubernetes
chrisshort
48
50k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
Become a Pro
speakerdeck
PRO
28
5.4k
Product Roadmaps are Hard
iamctodd
PRO
54
11k
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
29
2.7k
Building Flexible Design Systems
yeseniaperezcruz
328
39k
Transcript
Hypermedia APIs Hypermedia APIs Webmachine & ROAR 1 Larry Staton
Jr. : @statonjr 1 Wednesday, 14 November 12
Hypermedia APIs Assumptions 2 2 Wednesday, 14 November 12
Hypermedia APIs REST 3 3 Wednesday, 14 November 12
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
Hypermedia APIs 5 Uniform Interface 5 Wednesday, 14 November 12
Hypermedia APIs HTTP 6 6 Wednesday, 14 November 12
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
Hypermedia APIs “REST APIs must be hypertext-driven” 8 — Fielding,
2009! 8 Wednesday, 14 November 12
Hypermedia APIs 9 Richardson Maturity Model 9 Wednesday, 14 November
12
Hypermedia APIs Hypermedia 10 10 Wednesday, 14 November 12
Hypermedia APIs Media Types 11 11 Wednesday, 14 November 12
Hypermedia APIs 12 Media Type Hypermedia? text/html application/atom+xml application/json application/hal+json
12 Wednesday, 14 November 12
Hypermedia APIs HTTP 13 13 Wednesday, 14 November 12
Hypermedia APIs 14 14 Wednesday, 14 November 12
Hypermedia APIs Webmachine 15 15 Wednesday, 14 November 12
Hypermedia APIs Resources 16 16 Wednesday, 14 November 12
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
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
Hypermedia APIs 19 Webmachine::Application.new do |app| app.routes do add [],
HomeResource end end 19 Wednesday, 14 November 12
Hypermedia APIs Representation 20 20 Wednesday, 14 November 12
Hypermedia APIs HTML 21 21 Wednesday, 14 November 12
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
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
Hypermedia APIs HAL+JSON 24 24 Wednesday, 14 November 12
Hypermedia APIs 25 { “_links”: { “self”: { “href”: “.../api”
}, “vehicles”: { “href”: “.../vehicles” } } } Example HAL+JSON Representation 25 Wednesday, 14 November 12
Hypermedia APIs ROAR 26 26 Wednesday, 14 November 12
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
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
Hypermedia APIs Next Steps 29 29 Wednesday, 14 November 12
Hypermedia APIs Conclusion 30 30 Wednesday, 14 November 12
Hypermedia APIs Questions? 31 31 Wednesday, 14 November 12
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