Understanding REST APIs in 5 Simple Steps

ParisJS Meetup December 3rd, 2016

Follow me on Twitter and/or tweet at me. @tessamero

By Tessa Mero

Understanding REST APIs in 5 Simple Steps

2© 2016 Cisco and/or its affiliates. All rights reserved. Cisco Confidential

REST != $this


“It’s a way for two pieces of software to talk to each other”

Application Programming Interface


STEP 1: Understanding the Purpose of APIs


Why are APIs so Important?


API Growth from 2000 to 2016

2000 2005 2007 2009 2011 2013 2015 20160

5000

10000

15000

20000

25000

30000

35000API's

API's

Source: 2016 data from nordicapis.com. 2005-2015 data from rubenverborgh.github.io and 2000-2004 data from blog.cutter.com


An API is like …

An API (Application Programming Interface) is best thought of as a contract provided by one piece of computer software to another.


APIs help developers create apps that benefit the end user.

Yelp asks for Map Data

Google Maps returns map data

via API

Users sees list of

restaurants close to

them


STEP 2: Learn what REST is


A REST API defines a set of functions which developers can perform requests and receive responses via HTTP protocol such as GET and POST.


REST is best explained as a way to talk to other machines through the server with an HTTP Protocol

Using Verbs (actions) and Nouns (items)


STEP 3: Know What Request and Responses are


13

View a Web Page

Presentation ID


14

View a Web Page

Presentation ID

Request GET /index.htm HTTP/1.1

ResponseHTTP 200 OK

<html>


REST APIs use Request and Response too


16

Get Data using an API (Spark)

Presentation ID


17

Get Data using an API – Response!

Presentation ID

Request GET /rooms

ResponseHTTP 200 OK

{json data}

API Consumer API Provider


List of Verbs!


STEP 4: Documentation is Your Dictionary


API Reference for Rooms (Verbs and Nouns)


Request Parameters for “MESSAGES”


STEP 5: Learn How to Use Debug/Test Tools for APIs


Tools to Debug/Test http://tiny.cc/60tools

• Webhook Debugging (RequestBin formerly requestbin.org…)• Webhook Utilities (Torpio…)• Local Tunneling (ngrok...)• API Monitoring (Runscope...)• Response Mocking (mocky.io...) • JSON Utilities (JSONFormat...)• OAUTH Utilities (oauth.io...)• API Directories (APIS.io, ProgrammableWeb...)• API Testing (Runscope Radar...)• Load Testing (loader.io...)• GUI HTTP Clients (POSTMAN...)


POSTMAN!!!!!


25

method

url

requestheaders

status code

response headers

content-type

responsebody

query parameters


26

Add JSON to the Body in POSTMAN


Summary:

1. You Understand the Purpose2. You Know what REST is3. Request & Response – Makes sense4. Documentation – Live by it.5. Debugging&Test Tools – Prevent headaches


OUI!!!!!!!!


Thank You

@[email protected]

http://www.slideshare.net/Tessa99

mailto:[email protected]

Understanding REST APIs in 5 Simple Steps

Technology

Transcript of Understanding REST APIs in 5 Simple Steps