This document describes Apispark, an all-in-one platform that facilitates the building, hosting, and management of web APIs in under an hour. It contrasts the do-it-yourself (DIY) approach with a more efficient platform-as-a-service (PaaS) method and outlines the typical lifecycle of web API projects. The document emphasizes the advantages of using PaaS for rapid deployment, scalability, and ease of use, inviting feedback and engagement from developers and operations teams.

1. BUILD, HOST AND MANAGE
YOUR CUSTOM API IN LESS THAN AN HOUR
All-in-one platform for Web APIs
http://apispark.com
Stève SFARTZ
ssfartz@restlet.com
VP of Engineering
December 5, 2013

2. BIO
Steve SFARTZ




VP of Engineering @ Restlet
APISpark devs & ops teams
Restlet Framework dev teams
Scalable & interoperable architectures
Keeping in touch
 ssfartz@restlet.com
 Twitter : @SteveSfartz
 Blog : Think big … mais pas trop !

3. WEB API PROJECT
TYPICAL LIFE CYCLE
1) Do It Yourself (DIY)
long, risky, expensive but highly flexible
Create
Host
Manage
Use
2) Platform as a Service (PaaS)
integrated, fast, cost effective
Promote

4. with the Restlet framework
DO IT YOURSELF APPROACH

5. RESTLET FRAMEWORK
OPEN SOURCE PROJECT STARTED IN 2005
Create (and consume) Web APIs
in a REST style
Editions for
ANDROID
GAE
GWT
JAVA
SE
JAVA
EE
OSGI

6. LARGELY USED

7. SELF HOSTED OR EMBEDDED

8. FILTERING AND ROUTING
MULTI-THREADED AND DYNAMIC
A
B
C
Restlet Resource
Filter
Route 1
A
A
B
B
Route 2
C
C
Router
Route 3

9. UNIFIED APPROACH
FOR CLIENT AND SERVER SIDES
REST API
Client
proxy
Server
subclass
Annotated
Java interface
Client
resource
HTTP
Server
resource

10. CONVERSION SERVICE
EXTENSIBLE, SCORING, BEANS DE REPRÉSENTATION
Atom
Form Data
Resource
HTML
XML
JSON
RDF
…
Converter
service
Representation
bean
State

11. MULTIPLE PROTOCOLS
HTTP COMES FIRST, EXTEND IT TO SUIT YOUR NEEDS
Protocoles
Caching
Authentication
Conditional
requests
Ranged
requests
Restlet
API
Payload
Semantics
Messaging
Restlet
Engine
•
•
•
•
•
•
•
•
•
•
HTTP
AJP
FTP
RIAP
CLAP
FILE
POP3
SMTP
JDBC
SIP

12. CLOUD INTEGRATION
TUNNEL YOUR IT AND EXPOSE INTERNAL DATA

13. with APISpark
PAAS APPROACH

14. APISPARK PLATEFORM
Send us your feed-back
and help us making it
the best PaaS for Web
APIs !

15. Step 1
BUILD YOUR DATA SOURCE

16. DIY APPROACH
 Select a database technology
 that scales
 Specify the schema
 tables / sets, keys / queries, indexes
 Setup the database
 On premise or in the Cloud
 Ensure security, high availability and
performances
 From days to weeks

17. PAAS WAY
BACK END AS A SERVICE

18. Step 2
CREATE YOUR WEB API

19. DIY APPROACH
 Select an API framework that
 Lets you be productive and gets you on the way
 Leverages your skills
 Ensures your web API will scale and be secure
 Write the code
 Code, debug, unit tests
 Read, write, update your data
 Package the code
 From days to weeks

20. PAAS WAY
FULLY AUTOMATED

21. Step 3
DEPLOY YOUR WEB API

22. DIY APPROACH
 Choose a deployment target
 Private hosting with firewall / DMZ
 Public hosting : Cloud / Dedicated
 Select an API management solution
 Build your own from Open source, third
party products
 Leverage an API management service :
plug it in tasks and side effects
 Guaranty your SLA
 Test, QA, iterate, benchmark…
 From days to weeks to get started

23. PAAS WAY
INSTANT DEPLOY AND AUTO SCALE

24. Step 4
PROMOTE YOUR API

25. DIY APPROACH
 Write your API documentation
 Annotated your API code and generate ?
 Use HTML tooling ?
 Maintenance costs (versions sync)
 Provide client SDKs
 Write first SDKs
 Pray for community contributions for others ?
 Test, QA, iterate, etc.
 From days to weeks to get started

26. PAAS WAY
GENERATE CLIENT SDKS

27. PAAS WAY
BUILT-IN ANALYTICS

28. DIY VERSUS PAAS
SUMMARY
From weeks to months
Web API manager
Current practice:
• Team of engineers
• Heterogeneous stack
• Complex & expensive
to develop and
to operate
From minutes to hours
Web API definition
Custom code
Web API framework
Hosting
Generic PaaS
API Spark
• creation
• hosting
• management
• usage
All-in-one PaaS

29. HOW MANY APIS ?
TO BUILD AND MAINTAIN
Browser
HTTP
Connected
devices
Pages + API
Smart
environment
Web Site
Business
Partners
Internal IT

30. FINAL THOUGHTS
 How to build 1 million API in 2017 ?
– with radically simpler PaaS for Web APIs
– truly democratize Web APIs !
Source: Wired / June 2013

31. THE ALL-IN-ONE PLATFORM FOR
WEB APIS

32. JOIN US
 DevOps Engineers
 R&D Engineers
 Internships : R&D, devops
 Location : France (Nantes)
 http://restlet.com/about/hiring

33. KEEP IN TOUCH!
http://apispark.com
Twitter: @apispark
ssfartz@restlet.com