Build, host and manage your custom API in less than an hour

BUILD, HOST AND MANAGE
YOUR CUSTOM API IN LESS THAN AN HOUR
All-in-one platform for Web APIs
http://apispark.com
October 3, 2013
Jérôme LOUVEL
jlouvel@restlet.com
CEO

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

DEFINE YOUR DOMAIN MODEL
 Nothing new under the API sun !
 How is your domain model structured?
 Which information do you want expose?
 Common practices
 Domain entities and properties
 Reuse your data modeling experience
 Use OOA/D methodology or similar
→ Then implement it

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

PAAS WAY
DATABASE AS A SERVICE

SPECIFY YOUR WEB API
 What do you want to expose ?
 Which resources ?
 How to structure them ?
 Common practices
 REST / Resource Oriented approach
 Resources, representations, variants
 Use ROA/D methodology and similar

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

SPECIFY HOSTING NEEDS
 Who will access your API ?
 Public or Private ?
 Users, administrators, guests, support teams …
 Which SLA ?
 How much traffic do you expect ?
 How will you manage your API?
 Don’t forget about global security stakes

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

PAAS WAY
INSTANT DEPLOY AND AUTO SCALE

GIVING ACCESS TO YOUR API
 Think about API documentation
 Which client SDKs to provide ?
 How to measure your API success ?
 Monitor access to your API
 Usage statistics, analytics, trends
 Promote your API online
 Attract new API users

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

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

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

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

KEEP IN TOUCH!
Learn about the ROA/D
methodology !
http://apispark.com
Twitter: @apispark
jlouvel@restlet.com

Build, host and manage your custom API in less than an hour

More Related Content

What's hot (12)

Viewers also liked (20)

Similar to Build, host and manage your custom API in less than an hour (20)

More from Jerome Louvel (8)

Recently uploaded (20)

Build, host and manage your custom API in less than an hour