7 Habits of Highly Effective APIs

695 views

Published on

SoapUI creator Ole Lensmar's presentation from the 2013 API Strategy Conference

Published in: Technology
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
695
On SlideShare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
19
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

7 Habits of Highly Effective APIs

  1. 1. 7 Habits of highly effective APIsOle Lensmar, API aficionado@olensmar
  2. 2. your API is highly effective because…
  3. 3. it has a @twitter account
  4. 4. it has a @twitter account• communicates feature updates, new versions, etc• exposes itself in API directories• provides health / uptime / downtime info
  5. 5. it’s beautifully described
  6. 6. it’s beautifully described• generous and easily navigated documentation• code examples for “relevant” languages• metadata for code generation and testing
  7. 7. it’s instantly accessible
  8. 8. it’s instantly accessible• fully automated API key / account creation• generous developer quota• getting started tutorials and examples
  9. 9. it has a sandbox for experiments
  10. 10. 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
  11. 11. it has out-of-the-box clients
  12. 12. it has out-of-the-box clients• lowers barrier of entry• hides complexity related to authentication, parsing, etc• adapts API to client paradigms
  13. 13. it knows and serves its user
  14. 14. it knows and serves its user• uses the right technologies for the domain• respects security and authentication requirements• adopts common nomenclature and naming
  15. 15. it’s aware of its constraints
  16. 16. 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
  17. 17. it’s prepared for (r)evolution
  18. 18. 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
  19. 19. 3:30:3
  20. 20. 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!
  21. 21. Thank you!Ole Lensmar@olensmar

×