APIDays Paris 2014

Craft and Deploy your API in a few clicks

with online tooling

Presented by Jonathan Michaux, API Mad Scientist

1. Manage an API in a few simple steps

1. Announcement & short workshop: a dedicated IDE for crafting an API

What you’ll get from this workshop:

● Know what API management is, how and when to use it

What you’ll need:

● An HTTP client (install Postman, or use curl)

● Java Runtime Environment 1.7 or higher

What you won’t need:

● to write any code

● to be the owner of an existing API (I’ve got one for you)

Agenda

What’s new @ Restlet?

Why manage an existing API?

● You want to host your own API

○ You’re prepared to use external

tools for non-functional needs

● You want to enhance your existing API

○ documentation

○ access control

○ monetization

○ analytics

● Integrate with an ecosystem of tools

○ generate client SDKs & server

skeletons

Part I - Manage an API in a few steps

Example:

You host a public TV Program API:

GET /channels/france2

● You want to monitor the consumption

of your API to make sure your

infrastructure isn’t overkill

● You want set a rate limit to avoid

overloading your infrastructure during

consumption peaks

How API management works

● Agent

○ reverse proxy between

consumers and your API

○ different deployment

options exist

● Connector

○ User friendly interface to

configure your Agent

Connector

Agent

Backend

API

Devices

Information

System

Authentication

Authorisation

Firewall

Analytics

● The Poker Tourney API

○ Players & Tournaments

● Connector

○ An APISpark component

● The Agent

○ Reverse proxy

○ Downloadable from a

Connector

○ Open-source (Restlet

Framework)

API Management tools we’ll use

Connector

Agent

Authentication

Authorisation

Firewall

Analytics

Postman

HTTP

client

Poker

Tourney

Public API

API Management demo steps1. Discover the “Poker Tourney API”

Postman request collection:

GET http://pokertourneyapi.apispark.net/v1/postman/demo.json

2. Build a Connector for your APIhttps://www.apispark.restlet.com

3. Download your Agentfrom your Connector on APISpark

4. Invoke the managed APIActivate authentication

Activate authorization & rate limitation

Workshop

Management features config

Authentication

Rate limitation

Fine-grained authorisation

Part II - Crafting a new web API

Announcing…

New API development workflows

● API-driven approach benefits

o a pivot API descriptor

o server skeletons & mock generation

o up-to-date client SDKs & docs

o rapid API crafting & implementation

● Code-first or API-first approaches

o can be combined using

code introspectors to extract

code generators to resync

API source code

API descriptor

introspect generate

API

docs

generate generate

Client

SDKs

Crafting an API

● Specialized API crafting toolso code editors

o visual designers

o generation of

contract

client SDKs

skeletons

● New generation of toolso IDE-type

o Web-based

● Browser-based IDE for API craftingo accelerate the design of APIs

o Chrome extension

o compatible with other modern browsers

● Supportso visual design of APIs

o source code views

o APIs with large # of resources (sections)

o skeleton and SDK generation

o adherence to REST

o multiple API languages (Swagger & RAML initially)

Crafting an API with Restlet Studio

Workshop

More information

User guide on API Management

http://restlet.com/technical-resources/apispark/guide/manage/connectors

Restlet Studio User Guide

http://restlet.com/technical-resources/restlet-studio

Keep in touch!

jmichaux@restlet.com

@j_michaux