This workshop explained how to craft an API using the first multi-language dedicated Web IDE, host and scale the API with Platform as a Service for web APIs and manage access to this API; including: documentation, client SDKs, access management, firewall and analytics.

1. APIDays Paris 2014
Craft and Deploy your API in a few clicks
with online tooling
Presented by Jonathan Michaux, API Mad Scientist

2. Agenda
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)

3. What’s new @ Restlet?

4. Part I - Manage an API in a few steps
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
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

5. 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
API
Backend
Devices
Information
System
Authentication
Authorisation
Firewall
Analytics

6. API Management tools we’ll use
● The Poker Tourney API
○ Players & Tournaments
● Connector
○ An APISpark component
● The Agent
○ Reverse proxy
○ Downloadable from a
Connector
○ Open-source (Restlet
Framework)
Connector
Agent
Authentication
Authorisation
Firewall
Analytics
Postman
HTTP
client
Poker
Tourney
Public API

7. API Management demo steps
1. Discover the “Poker Tourney API”
Postman request collection:
GET http://pokertourneyapi.apispark.net/v1/postman/demo.json
2. Build a Connector for your API
https://www.apispark.restlet.com
3. Download your Agent
from your Connector on APISpark
4. Invoke the managed API
Activate authentication
Activate authorization & rate limitation

8. Workshop

10. Management features config

11. Authentication

12. Rate limitation

13. Fine-grained authorisation

14. Part II - Crafting a new web API
Announcing…

15. 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
introspect generate
API descriptor
generate generate
API
docs
Client
SDKs

16. Crafting an API
● Specialized API crafting tools
o code editors
o visual designers
o generation of
 contract
 client SDKs
 skeletons
● New generation of tools
o IDE-type
o Web-based

17. Crafting an API with Restlet Studio
● Browser-based IDE for API crafting
o accelerate the design of APIs
o Chrome extension
o compatible with other modern browsers
● Supports
o 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)

18. Workshop

22. 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