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
   

   View Slide

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.
   

   View Slide

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)
   

   View Slide

4. View Slide

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
   

   View Slide

6. View Slide

7. 3. PROVIDE HELPFUL API
   RESPONSES
   "I LOVE RECEIVING "BAD REQUEST" RESPONSES WITH NO
   CONTEXT." - NOBODY EVER.
   

   View Slide

8. View Slide

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
   

   View Slide

10. View Slide

11. View Slide

12. View Slide

13. 5. PROVIDE A TESTING
    SANDBOX WITH LOGS
    FOR YOUR OWN SANITY.
    

    View Slide

14. View Slide

15. View Slide

16. 6. BUILD A COMMUNITY
    AND OFFER SUPPORT
    DEVELOPERS WILL BE YOUR BEST - AND WORST - ADVOCATES.
    MAKE FRIENDS WITH THEM.
    

    View Slide

17. View Slide

18. View Slide

19. View Slide

20. View Slide

21. View Slide

22. View Slide

23. View Slide

24. CONTACT
    

    View Slide