Upgrade to Pro — share decks privately, control downloads, hide ads and more …

How to create an API experience that people will rave about

61857dafbd287b3027c4dcea9008ad3c?s=47 Carmen Chung
September 20, 2019

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.

61857dafbd287b3027c4dcea9008ad3c?s=128

Carmen Chung

September 20, 2019
Tweet

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)
  4. None
  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
  6. None
  7. 3. PROVIDE HELPFUL API RESPONSES "I LOVE RECEIVING "BAD REQUEST"

    RESPONSES WITH NO CONTEXT." - NOBODY EVER.
  8. None
  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
  10. None
  11. None
  12. None
  13. 5. PROVIDE A TESTING SANDBOX WITH LOGS FOR YOUR OWN

    SANITY.
  14. None
  15. None
  16. 6. BUILD A COMMUNITY AND OFFER SUPPORT DEVELOPERS WILL BE

    YOUR BEST - AND WORST - ADVOCATES. MAKE FRIENDS WITH THEM.
  17. None
  18. None
  19. None
  20. None
  21. None
  22. None
  23. None
  24. CONTACT