API Love Story

{"api": "❤"}

Who?

Ahmad Nassri

{
  "name": "Ahmad Nassri",
  "url": "http://www.ahmadnassri.com/",
  "twitter": "http://twitter.com/ahmadnassri",
  "email": "ahmad@ahmadnassri.com",
  "bio": "Technologist, Entrepreneur, Dog Lover.",
  "work": {
    "company": "Mashape.com",
    "job": "API Master"
  },
  "activites": [
    "blogging",
    "open-source projects"
  ],
  "meetups": [
    "#YeomanTO",
    "#FBTO"
  ]
}

Mashape is the largest API hub in the world where you can consume, distribute, monitor and monetize your public and private APIs.

A revenue generating platform for technology startups
Powering thousands of APIs and Applications
Used in almost 100 countries by thousands of developers
Adopted in every major industry including finance, healthcare, military, agriculture, insurance, government, media, e-commerce, retail, aviation, manufacturing and telecom.

In Egyptian mythology, Apis, is a bull-deity that was worshipped in the Memphis region. Apis served as an intermediary between humans and an all-powerful god.

Egyptology

an application programming interface (API) specifies a software component in terms of its operations, their inputs and outputs and underlining types. Its main purpose is to define a set of functionalities that are independent of their respective implementation, allowing both definition and implementation to vary without compromising each other.

Computer Programming

Web Services

A Web service is a method of communication between two electronic devices over a network. It is a software function provided at a network address over the web with the service always on as in the concept of utility computing.

© http://www.slideshare.net/markedgington

RESTful Web APIs

Originally communicated by Roy Fielding in his doctoral dissertation The REST architectural style describes six constraints:

Uniform Interface
Stateless
Cacheable
Client-Server
Layered System
Code on Demand (optional)

REpresentational State Transfer

API Love Story

{"api": "❤"}

RESTful Web API Love Story

{"restful-web-api": "❤"}

Story so far...

[1991] Started as notes written by Tim Berners Lee.
[1996] First standard HTTP/1.0 version (RFC 1945).
[1999] HTTP/1.1 (RFC 2616) & REST
[2007] Refactoring with HTTP/1.1 bis
[2009] SPDY
[2012] IETF working group for HTTPbis released draft of HTTP 2.0
- SPDY was chosen as the starting point.
[June 2014] RFC2616 is Dead!
[Aug 2014] HTTP 2.0 Last Call!

Core Specifications
- RFC7230 - HTTP/1.1: Message Syntax and Routing
- RFC7231 - HTTP/1.1: Semantics and Content
Optional / Widely Used
- RFC7232 - HTTP/1.1: Conditional Requests
- RFC7233 - HTTP/1.1: Range Requests
- RFC7234 - HTTP/1.1: Caching
- RFC7235 - HTTP/1.1: Authentication
- RFC6265 - HTTP State Management Mechanism

These RFCs collectively obsolete all preceding RFCs defining HTTP, including RFC1945, RFC2068 and RFC2616.

http://httpwg.github.io
http://http2.github.io

How to GET a Cup of Coffee

http://www.infoq.com/articles/webber-rest-workflow

The Customer Workflow

The Barista's Workflow

Workflow


http POST localhost:3000/order drink=coffee

HTTP/1.1 201 Created
Connection: keep-alive
Content-Length: 132
Content-Type: application/json; charset=utf-8
Date: Tue, 26 Aug 2014 16:37:55 GMT
Location: http://localhost:3000/order/1409071075510

{
    "cost": 3, 
    "drink": "coffee", 
    "next": {
        "rel": "http://localhost:3000/payment", 
        "uri": "http://localhost:3000/payment/order/1409071075510"
    }
}

POST /order HTTP/1.1
Host: localhost:3000
Content-Type: application/json; charset=utf-8

{
    "drink": "coffee"
}

router.post('/order', function(req, res) {
  // generate new id
  var id = '123';

  // create object
  var order = {
    drink: req.body.drink,
    cost: 3,
    next: {
      rel: 'http://' + req.get('host') + '/payment',
      uri: 'http://' + req.get('host') + '/payment/order/' + id
    }
  };

  // save order
  store.set(id, order);

  // status
  res.status(201);

  // headers
  res.set({'Location': 'http://' + req.get('host') + '/order/' + id});

  // respond
  res.send(order);
});


http OPTIONS localhost:3000/order/1409071075510

HTTP/1.1 200 OK
Allow: GET,PUT
Connection: keep-alive
Content-Length: 7
Content-Type: text/html; charset=utf-8
Date: Tue, 26 Aug 2014 16:54:44 GMT

GET,PUT

OPTIONS /order/1409071075510 HTTP/1.1
Host: localhost:3000


http PUT localhost:3000/order/1409071075510 additions=shot

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 151
Content-Type: application/json; charset=utf-8
Date: Tue, 26 Aug 2014 16:53:07 GMT
Location: http://localhost:3000/order/1409071075510

{
    "additions": "shot", 
    "cost": 4, 
    "drink": "coffee", 
    "next": {
        "rel": "http://localhost:3000/payment", 
        "uri": "http://localhost:3000/payment/order/1409071075510"
    }
}

PUT /order/1409071075510 HTTP/1.1
Host: localhost:3000
Content-Type: application/json; charset=utf-8

{
    "additions": "shot"
}

router.put('/order/:id', function(req, res) {
  var id = req.param('id');
  var order = store.get(id);

  // modify order
  order.additions = req.body.additions;
  order.cost += 1;

  // save order
  store.set(id, order);

  // status
  res.status(200);

  // headers
  res.set({'Location': 'http://' + req.get('host') + '/order/' + id});

  res.send(order);
});


http PUT localhost:3000/order/1409071075510 additions=moar+shots

HTTP/1.1 409 Conflict
Connection: keep-alive
Content-Length: 151
Content-Type: application/json; charset=utf-8
Date: Tue, 26 Aug 2014 16:53:07 GMT
Location: http://localhost:3000/order/1409071075510

{
    "additions": "shot", 
    "cost": 4, 
    "drink": "coffee", 
    "next": {
        "rel": "http://localhost:3000/payment", 
        "uri": "http://localhost:3000/payment/order/1409071075510"
    }
}

PUT /order/1409071075510 HTTP/1.1
Host: localhost:3000
Content-Type: application/json; charset=utf-8

{
    "additions": "moar shots"
}


http GET localhost:3000/order/1409071075510

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 151
Content-Type: application/json; charset=utf-8
Date: Tue, 26 Aug 2014 16:53:07 GMT
Location: http://localhost:3000/order/1409071075510

{
    "additions": "shot", 
    "cost": 4, 
    "drink": "coffee", 
    "next": {
        "rel": "http://localhost:3000/payment", 
        "uri": "http://localhost:3000/payment/order/1409071075510"
    }
}

GET /order/1409071075510 HTTP/1.1
Host: localhost:3000
Accept: application/json

router.get('/order/:id', function(req, res) {
  var id = req.param('id');
  var order = store.get(id);

  res.status(200).send(order);
});


http OPTIONS localhost:3000/payment/order/1409071075510

HTTP/1.1 200 OK
Allow: GET,PUT
Connection: keep-alive
Content-Length: 7
Content-Type: text/html; charset=utf-8
Date: Tue, 26 Aug 2014 16:54:44 GMT

GET,PUT

OPTIONS /payment/order/1409071075510 HTTP/1.1
Host: localhost:3000

http PUT localhost:3000/payment/order/1409071075510 \
     --auth-type=digest \
     -a ahmad:123 \
     cardNo=123456789 expires="07/15" name="Ahmad Nassri" amount="4.00"

HTTP/1.1 201 Created
Connection: keep-alive
Content-Length: 151
Content-Type: application/json; charset=utf-8
Date: Tue, 26 Aug 2014 16:53:07 GMT

{
    ...

    "payment": {
        "amount": "4.00", 
        "cardNo": "123456789", 
        "expires": "07/15", 
        "name": "Ahmad Nassri"
    }
}

PUT /payment/order/1409071075510 HTTP/1.1
Host: localhost:3000
Content-Type: application/json; charset=utf-8
Authorization: Digest username="ahmad" realm="localhost" nonce="..." ...

{
    "amount": "4.00", 
    "cardNo": "123456789", 
    "expires": "07/15", 
    "name": "Ahmad Nassri"
}

router.put('/payment/order/:id', function(req, res) {
  var id = req.param('id');
  var order = store.get(id);

  // modify order
  order.payment = {
    cardNo: req.body.cardNo,
    expires: req.body.expires,
    name: req.body.name,
    amount: req.body.amount
  };

  // save order
  store.set(id, order);

  // status
  res.status(201);

  // headers
  res.set({'Location': 'http://' + req.get('host') + '/order/' + id});

  res.send(order);
});

github.com/ahmadnassri/get-express-coffee

Hypermedia Hype

Collection+JSON

Hypertext Application Language (HAL)