7 Habits of Highly Effective APIs
-
Upload
smartbear -
Category
Technology
-
view
482 -
download
2
description
Transcript of 7 Habits of Highly Effective APIs
![Page 1: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/1.jpg)
7 Habits of highly effective APIs
Ole Lensmar, API aficionado
@olensmar
![Page 2: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/2.jpg)
your API is highly effective because…
![Page 3: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/3.jpg)
it has a @twitter account
![Page 4: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/4.jpg)
it has a @twitter account
• communicates feature updates, new versions, etc
• exposes itself in API directories
• provides health / uptime / downtime info
![Page 5: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/5.jpg)
it’s beautifully described
![Page 6: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/6.jpg)
it’s beautifully described
• generous and easily navigated documentation
• code examples for “relevant” languages
• metadata for code generation and testing
![Page 7: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/7.jpg)
it’s instantly accessible
![Page 8: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/8.jpg)
it’s instantly accessible
• fully automated API key / account creation
• generous developer quota
• getting started tutorials and examples
![Page 9: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/9.jpg)
it has a sandbox for experiments
![Page 10: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/10.jpg)
it has a sandbox for experiments
• limited functionality or content
• simulations of errors and out-of-bounds situations
• no limits on usages – doesn’t consume quota
![Page 11: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/11.jpg)
it has out-of-the-box clients
![Page 12: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/12.jpg)
it has out-of-the-box clients
• lowers barrier of entry
• hides complexity related to authentication, parsing, etc
• adapts API to client paradigms
![Page 13: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/13.jpg)
it knows and serves its user
![Page 14: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/14.jpg)
it knows and serves its user
• uses the right technologies for the domain
• respects security and authentication requirements
• adopts common nomenclature and naming
![Page 15: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/15.jpg)
it’s aware of its constraints
![Page 16: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/16.jpg)
it’s aware of its constraints
• continuously evaluates its performance and availability
• monitors 3rd party APIs and dependencies
• handles unexpected events gracefully with the user in mind
![Page 17: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/17.jpg)
it’s prepared for (r)evolution
![Page 18: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/18.jpg)
it’s prepared for (r)evolution
• versioned from day 1 in line with best practices
• communicates and implements a versioning strategy
• handles “old” clients gracefully
![Page 19: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/19.jpg)
3:30:3
![Page 20: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/20.jpg)
3:30:3
• 3 seconds to understand what the API does
• 30 seconds to find the endpoint
• 3 minutes to be up and running
Thanks to Ori Pekelman!
![Page 21: 7 Habits of Highly Effective APIs](https://reader038.fdocuments.us/reader038/viewer/2022102805/554f948eb4c905d25b8b53ef/html5/thumbnails/21.jpg)
Thank you!
Ole Lensmar
@olensmar