Intro to Web API & Hypermedia

Intro to Web API & Hypermedia Email: [email protected] Twitter: @dmtrsslvdr

Who am I?

Internet != Web

Web browser A software application for retrieving, presenting and traversing
information resources on the World Wide Web. An information resource may be a web page, image, video or other piece of content.

Hypermedia Web API

Web API means HTTP

HTTP is RFC7230

MUST MUST NOT SHOULD SHOULD NOT MAY

Client ⇄ Server

Client An HTTP "client" is a program that establishes a
connection to a server for the purpose of sending one or more HTTP requests.

Server An HTTP "server" is a program that accepts connections
in order to service HTTP requests by sending HTTP responses.

Request

METHOD Request-Header: value ... “Payload Body” uri

METHOD Request-Header: value ... “Payload Body” 1 uri

HTTP Methods GET, POST, PUT, DELETE HEAD, CONNECT, TRACE,OPTIONS

METHOD Request-Header: value ... “Payload Body” 1 uri

GET Request-Header: value ... “Payload Body” 1 uri

GET Request-Header: value ... “Payload Body” 2 uri

Unique Resource Identifier ...a compact sequence of characters that identifies
an abstract or physical resource. RFC3986

GET Request-Header: value ... “Payload Body” 2 /templates

GET Request-Header: value ... “Payload Body” 3 /templates

GET Accept: text/html ... “Payload Body” 3 /templates

GET Accept: text/html ... “Payload Body” 4 /templates

A payload within a GET request message has no defined
semantics; sending a payload body on a GET request might cause some existing implementations to reject the request. 4

GET Accept: text/html ... /templates

Response

Status code Response-Header: value ... “Payload Body”

Status code Response-Header: value ... “Payload Body” 1

Status codes 2xx 3xx 4xx 5xx

200 Response-Header: value ... “Payload Body” 1

200 Response-Header: value ... “Payload Body” 2

200 Content-Type: application/json ... “Payload Body” 2

200 Content-Type: application/json ... “Payload Body” 3

200 Content-Type: application/json ... { “data”: [ “...” ] }
3

{ “data”: [ “...” ] }

(Hyper)Media Types

Hypermedia A way for the server to tell the client
what request what HTTP requests the client want to make in the future

text/html

GET http://ampiri.com Accept: text/html

GET http://ampiri.com Accept: text/html 200 Content-Type: text/html <html><head>...

{ “data”: [ “...” ] }

{ json:api } application/vnd.api+json

MUST MUST NOT SHOULD SHOULD NOT MAY

A Web API is an interface for….

Human-driven clients They present representations to a human being, and
convey the human’s decisions back to the server.

Automated clients Automated clients receive representations but don’t render them.
There’s no human to see the rendering.

Automated clients • Monitor • Scripts • Crawler • Agent

Agent A software agent simulates a human being who is
actively engaged with a problem. It looks at a representation, analyzes the situation, and decides which hypermedia control to activate to get closer to its final goal.

Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing Resources

Intro to Web API & Hypermedia

Intro to Web API & Hypermedia

More Decks by Dimitrios Flaco Mengidis

Other Decks in Technology

Featured

Transcript