YOW! Nights - YOW! Conference · 2019. 9. 23. · Kevin O’Neill - CTO PlayUp - @kevinoneill YOW! Nights - March 2013 “What needs to be done to make the ReST architectural style

Kevin O’NeillCTO PlayUp

YOW!Nights

@kevinoneill

March 2013

YOW! Nights - March 2013Kevin O’Neill - CTO PlayUp - @kevinoneill

Roadmap

• ReST and Hypermedia

• An example of a Hypermedia driven service

• Tips & Trips

A jumping off point

Opinionated

ReST & Hypermedia

Representational State Transfer (ReST) is a style of software architecture for distributed

hypermedia systems such as the World Wide Web

ReST is not a meaningful term

One URL ≠ ReST

http://example.com/system?action=getUser&uid=3

http://example.com/system?action=mkUser&name=…

http://example.com/system?action=rmUser&uid=3

Resources = ReST

http://example.com/users/3

http://example.com/users/<uid>

http://example.com/users/<uid>/friends

HTTP Verbs = ReST

POST http://example.com/users

GET http://example.com/users/3

PUT http://example.com/users/3

DELETE http://example.com/users/3

What is ReST really?

"ReST is software design on the scale of decades: every detail is intended to promote software longevity and independent evolution. Many of the constraints are directly opposed to short-term ef"ciency. Unfortunately, people are fairly good at short-term design, and usually awful at long-term design."

Roy Fielding

The constraints of ReST

Client Server

Stateless Server

Cacheable

Uniform Interface

Layered System

Code-On-Demand(optional)

Uniform Interface

Identi"cation of Resources

Manipulation of resources through

representations

Self-descriptive messages

Hypermedia as the engine of application

“What needs to be done to make the ReST architectural style clear on the notion that hypertext is a constraint? In other words, if the engine of application state (and hence the API) is not being driven by hypertext, then it cannot be ReSTful and cannot be a ReST API. Period. Is there some broken manual somewhere that needs to be "xed?”

Roy T. Fielding

A Hypermedia driven service

PlayUp Pass

AppStore

TicketService

7:20 PM

1 Get Section

2 Get Tile

3 Priced Tile

4 Section

5�*HW�RHU��3OD\8SBL26BRHUB�� 6�2HU��$SSB6WRUHB7LHUB��

7 Get Price�$SSB6WRUHB7LHUB��

8 $��

ContentProvider

Getting the Price

Products":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ] ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ], }

":type": "application/vnd.playup.ticketing.product+json"

Preview":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ] ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ], }

"preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json"},

Preview":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ] ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ], }

":type": "application/vnd.playup.stream.story+json"

Accept Header

Accept

application/vnd.playup.stream.story+json,*/*

":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ] ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ], }

Preview

":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}"

URI Parameterization

URI Parameterization":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ] ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ], }

{token:ticketing_sample_provider}

URI Parameterizationhttp://april.ticket-‐provider.playupdev.com/content/82/preview?token=ABBr0dVOGRdPpF%2BAqll9sJNJAICWEHK%2BnTngDMzBI5IiABmlstT3RjwIBGkJpUCX3lchMQF3OrGoYyiYHh8zAbc7m%2FhsttbKyBBa%2BiX5hSApeBi1erBw7oJH9LBmk%2B1pfL2zApBDxCZZpJCkT5hScK1Z2g3%2BDhqkrQJTs3PQumbbC9bXJRnENksQhsb%2BNJuFrJ47sAGQBPPXyN0hy40i3J6LcwGMUSFIaR5kIAw3%2BiYyiKgC35rmZzvMYGEeV%2F08YR1ih47aKct5%2Fk0CTbzR06qxi1W11fR3pSMBn3HxqgYPjjMdgsa%2B5PiLv102eTk7kXc4Aqz1VDN2ogqu3qDbzebxdp6OOhnoSKa3jebrV9MOH6IgBRKYfiujq7MNle1xV1LwUQlm3T4BagclibIqOq%2FS1psWo0oZfU1DQW5h2AX%2BLrvF%2BGfgFRiHvaOWBUuq5esY0yqENyjD3Yu8WGq15MTqI36oK5S6hUy%2F0gAlB0rFMU%2BSX4WbuX64yjlKVWV5wr7E3FmaxT7yr98pGq04zKrJv2tn4rpUtcRoc8LrYiK2BdoQplYATGBCDgv68p%2FTiislPJv0%2B4hqhO5oAIv7fMa81uy%2F5WMcOjzmmsOgJzua0%2B%2FarXna9I3d0djqJ9fTDSQkM6icwz5u2P%2Btulzwq8UHEgYEFYFGUKyk%2BEXUgre7nttltajpLL3fRqGfrUqyI1NNM1dqGjeDN4zL0YA8KujtSoSWcA%3D%3D

Offers":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ] ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ], }

":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}"

Offers":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ], ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ] }

Text ":options": [ "POST" ]

":acceptable_types": [ "application/vnd.playup.encrypted+json ;embedded= \"application/vnd.playup.ticketing.product.details+json\" ;for=\"ticket_service\""]

Media Types

Media Typesdescribe a domain speci"c protocol

application/json

Media Type Explosion

Media Types":type": "application/vnd.playup.ticketing.product+json", "product": { "detail": { ":type": "application/vnd.playup.encrypted+json", "aes256-‐cbc": { "data": " … ", "iv": " … ", "key": " … ", "signature": " … ", "type": "application/vnd.playup.ticketing.product.detail+json" } }, "id": "82699e9b-‐b147-‐46b4-‐a90c-‐24316071b6e9", "name": "F1 GP Insider", "preview": { ":href": "http://april.ticket-‐provider.playupdev.com/content/82/preview?token={token:ticketing_sample_provider}", ":type": "application/vnd.playup.stream.story+json" }, "provider": "ticketing_sample_provider"}, "offer": { ":href": "http://april.ticket.playupdev.com/ticket?provider=ticketing_sample_provider&token={token:ticket_service}", ":options": [ "POST" ] ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"" ], }

Media Types

application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.product.details+json\";for=\"ticket_service\"

Media Types

Something to consider

Format vs Type

application/vnd.playup.stream+json

Format vs Type

application/vnd.playup.stream+json

Format vs Type

application/vnd.playup.stream+mp

Format vs Type

application/vnd.playup.stream;format=\”json\”

So now we post

Offer{ ":type": "application/vnd.playup.ticketing.offer+json", "content": { "expiration": "2015-‐03-‐13 01:12:44 +0000", "store-‐product": [ { "product": "com.playup.content.pricing.tier1", "vendor": "appstore" } ] }, "verification": { "key": "…", "link": { ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.receipt+json\";for=\"ticket_service\"" ], ":href": "http://april.ticket.playupdev.com/receipt?token={token:ticket_service}", ":options": [ "POST" ] } }}

"content": { "expiration": "2015-‐03-‐13 01:12:44 +0000", "store-‐product": [ { "product": "com.playup.content.pricing.tier1", "vendor": "appstore" } ]}

{ ":type": "application/vnd.playup.ticketing.offer+json", "content": { "expiration": "2015-‐03-‐13 01:12:44 +0000", "store-‐product": [ { "product": "com.playup.content.pricing.tier1", "vendor": "appstore" } ] }, "verification": { "key": "…", "link": { ":acceptable_types": [ "application/vnd.playup.encrypted+json;embedded=\"application/vnd.playup.ticketing.receipt+json\";for=\"ticket_service\"" ], ":href": "http://april.ticket.playupdev.com/receipt?token={token:ticket_service}", ":options": [ "POST" ] } }}

"link": { ":href": "http://april.ticket.playupdev.com/receipt…", ":options": [ "POST" ], ":acceptable_types": [ "application/vnd.playup.encrypted+json;…" ]}

Tips & Trips

API Versioning

Versioning

X-‐PlayUp-‐API-‐Version

Don’t Do It

Server Decides

User-‐Agent

PlayUp%20Pass/3.5.5233 CFNetwork/609.1.4 Darwin/13.0.0

Client Decides

"link": { ":representations": [ { "href": "http://twinstapics.playupdev.com/photos/86/stream …" , "type": "application/vnd.playup.stream+json" }, { "href": "http://twinstapics.playupdev.com/photos/86/section …" , "type": "text/html" } ], ":self": "http://twinstapics.playupdev.com/photos/86/section …", ":type": "text/html"},

Client Decides

"link": { ":representations": [ { "href": "http://twinstapics.playupdev.com/photos/86/stream …" , "type": "application/vnd.playup.stream+json" }, { "href": "http://twinstapics.playupdev.com/photos/86/section …" , "type": "text/html" } ], ":href": "http://twinstapics.playupdev.com/photos/86/section …", ":type": "text/html"},

Client Decides

"link": { ":representations": [ { "href": "http://twinstapics.playupdev.com/photos/86/stream …" , "type": "application/vnd.playup.stream+json" }, { "href": "http://twinstapics.playupdev.com/photos/86/section …" , "type": "text/html" } ], ":href": "http://twinstapics.playupdev.com/photos/86/section …", ":type": "text/html"},

Client vs Server

Document Evolution

The client should ignore what it doesn’t

understand

Don’t add or remove mandatory "elds

New Media Type

"Realtime" Updates

Polling

Leverage Infrastructure

Dynamic Scaling

Cache Headers

ETag"9461cf5ecc0f4df6e880ce76479aba90"

Cache-‐Controlmax-‐age=15, public

VaryAccept-‐Language

Cache Headers

ETag"9461cf5ecc0f4df6e880ce76479aba90"

Cache-‐Controlmax-‐age=15, public

VaryAccept-‐Language

Cache-‐Control max-‐age=15, public

Other Choices

Charles

Fiddler

Link Conditioner

Wireshark

rvictl -‐s <device UDID>

/def/bpf*

Kevin O’NeillCTO - PlayUp

kevin@playup.com@kevinoneill

Questions?

YOW! Nights - YOW! Conference · 2019. 9. 23. · Kevin O’Neill - CTO PlayUp - @kevinoneill YOW! Nights - March 2013 “What needs to be done to make the ReST architectural style

Documents

YOW! JVM Demystified Dave Thomas

YOW! 2010 Day 1

YOW! Nights in Brisbane - DooM - How to survive the Digital....

Practical microservices - YOW 2013

YOW Cloud Night Slides

YOW West 2017 - YOW! Conference...YOW West 2017 OUR SPONSORS...

Tokoh Awal Pelukis Tanahair-fung Yow Chork

YOW! 2010 Day 2

YOW Night Azure Preso

Yow che GRINCH

Yow Were Born Rich

Beyond JVM - YOW Melbourne 2013

Cancún - events-cms.s3.amazonaws.com€¦ · WESTIN RESORT...

YOW WEST 2014: "Adopting Functional Programming Languages"

Yow Surfing the Streets 2016 catalog

BY:EBONY YOW JUNE 3 RD 2015 SUMMER ENRICHMENT BY:EBONY YOW.....