HOW TO CREATE AN API EXPERIENCE
PEOPLE WILL RAVE ABOUT
Slide 2
Slide 2 text
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.
Slide 3
Slide 3 text
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)
Slide 4
Slide 4 text
No content
Slide 5
Slide 5 text
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
Slide 6
Slide 6 text
No content
Slide 7
Slide 7 text
3. PROVIDE HELPFUL API
RESPONSES
"I LOVE RECEIVING "BAD REQUEST" RESPONSES WITH NO
CONTEXT." - NOBODY EVER.
Slide 8
Slide 8 text
No content
Slide 9
Slide 9 text
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
Slide 10
Slide 10 text
No content
Slide 11
Slide 11 text
No content
Slide 12
Slide 12 text
No content
Slide 13
Slide 13 text
5. PROVIDE A TESTING
SANDBOX WITH LOGS
FOR YOUR OWN SANITY.
Slide 14
Slide 14 text
No content
Slide 15
Slide 15 text
No content
Slide 16
Slide 16 text
6. BUILD A COMMUNITY
AND OFFER SUPPORT
DEVELOPERS WILL BE YOUR BEST - AND WORST - ADVOCATES.
MAKE FRIENDS WITH THEM.