![Page 1: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/1.jpg)
BUILD, HOST AND MANAGEYOUR CUSTOM API IN LESS THAN AN HOUR
All-in-one platform for Web APIshttp://apispark.com
October 3, 2013
Jérôme [email protected]
CEO
![Page 2: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/2.jpg)
WEB API PROJECTTYPICAL 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
![Page 3: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/3.jpg)
BUILD YOUR DATA SOURCE
Step 1
![Page 4: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/4.jpg)
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
![Page 5: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/5.jpg)
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
![Page 6: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/6.jpg)
PAAS WAYDATABASE AS A SERVICE
![Page 7: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/7.jpg)
CREATE YOUR WEB API
Step 2
![Page 8: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/8.jpg)
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
→ Then implement it
![Page 9: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/9.jpg)
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
![Page 10: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/10.jpg)
PAAS WAYFULLY AUTOMATED
![Page 11: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/11.jpg)
DEPLOY YOUR WEB API
Step 3
![Page 12: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/12.jpg)
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
→ Then implement it
![Page 13: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/13.jpg)
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
![Page 14: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/14.jpg)
PAAS WAYINSTANT DEPLOY AND AUTO SCALE
![Page 15: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/15.jpg)
PROMOTE YOUR API
Step 4
![Page 16: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/16.jpg)
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
![Page 17: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/17.jpg)
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
![Page 18: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/18.jpg)
PAAS WAYGENERATE CLIENT SDKS
![Page 19: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/19.jpg)
PAAS WAYBUILT-IN ANALYTICS
![Page 20: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/20.jpg)
DIY VERSUS PAASSUMMARY
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 andto operate
From minutes to hours
API Spark• creation• hosting• management• usage
All-in-one PaaS
Web API definition
![Page 21: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/21.jpg)
HOW MANY APIS ? TO BUILD AND MAINTAIN
Web Site
Pages + API
Browser
Connected devices
Smartenvironment
Business Partners Internal IT
HTTP
![Page 22: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/22.jpg)
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
![Page 23: Build, host and manage your custom API in less than an hour](https://reader033.vdocument.in/reader033/viewer/2022060116/55823838d8b42a0d368b4b83/html5/thumbnails/23.jpg)
KEEP IN TOUCH!
Learn about the ROA/D methodology !
http://apispark.com
Twitter: @apispark