How to create an API experience that people will rave about

This presentation walks you through a few key steps to building a frictionless, enjoyable API that developers outside of your company will rave about (in a good way). Case studies included.

Transcript

1. HOW TO CREATE AN API EXPERIENCE PEOPLE WILL RAVE ABOUT
2. WHAT WE'LL TALK ABOUT KEEP YOUR API DESIGN SIMPLE FOLLOW CONVENTION AND BE CONSISTENT PROVIDE HELPFUL API RESPONSES OFFER CLEAR DOCUMENTATION WITH MOCKED EXAMPLES PROVIDE A TESTING SANDBOX WITH LOGS BUILD A COMMUNITY AND OFFER SUPPORT 1. 2. 3. 4. 5. 6.
3. 1. KEEP YOUR API DESIGN SIMPLE “AN API IS LIKE A JOKE. IF YOU HAVE TO EXPLAIN IT, IT’S NOT THAT GOOD.” - RON KURIS (PARAPHRASED)
5. 2. FOLLOW CONVENTION AND BE CONSISTENT "THERE ARE TWO HARD THINGS IN COMPUTER SCIENCE: CACHE INVALIDATION, NAMING THINGS, AND OFF-BY-ONE ERRORS." - LEON BAMBRICK
7. 3. PROVIDE HELPFUL API RESPONSES "I LOVE RECEIVING "BAD REQUEST" RESPONSES WITH NO CONTEXT." - NOBODY EVER.
9. 4. OFFER CLEAR DOCUMENTATION WITH MOCKED EXAMPLES "ASK ANYONE IN THE API INDUSTRY WHAT THE BIGGEST OBSTACLES ARE TO CREATING APPS, AND I GUARANTEE THAT THEY WILL BRING UP API DOCUMENTATION." - API EVANGELIST
13. 5. PROVIDE A TESTING SANDBOX WITH LOGS FOR YOUR OWN SANITY.
16. 6. BUILD A COMMUNITY AND OFFER SUPPORT DEVELOPERS WILL BE YOUR BEST - AND WORST - ADVOCATES. MAKE FRIENDS WITH THEM.
24. CONTACT