Hypermedia, REST, SOAP... It's not a matter of "why" anymore but rather of "how". Still, once your API is all set up, getting developers to use it is a real challenge. A challenge you should be ready to rise to as your API can eventually be its own channel for product adoption. How to make sure developers know about your API, that they use it efficiently and finally, that they love using it.

1. Getting Developers
hooked on your API
@nico_g

2. Nicolas Garnier
self-taught developer
@nico_g
@nico_g

3. @nico_g
~15,000 APIs
(ProgrammableWeb)

4. @nico_g
A great product sells itself

5. @nico_g
You’re not
the only
one
People don’
t know
about you
Your
onboarding
is crappy

6. @nico_g
One thing in common

7. @nico_g
US!
One thing in common

8. @nico_g
Developer Experience
code application

9. @nico_g
code application
Developer Experience
UX

10. @nico_g
code application
Developer Experience
DX

11. Developer Experience
matters
Journey to developer
Adoption
@nico_g

12. @nico_g
Simplicity
What are we looking for as
users?

13. @nico_g
Is it easy to
use?
GET /resourceH2B?vo=true

14. @nico_g
Is it easy to
understand?
Error 1543bis

15. @nico_g
Is it adapted to my
audience?

16. @nico_g
SOAP
REST
Hypermedia
GraphQL FalcorJS

17. @nico_g
What really matters is
affordance & consistency

18. @nico_g
Affordance
/pets/$ID

19. @nico_g
Affordance
GET /pets/$ID

20. @nico_g
Consistency
POST /foods

21. @nico_g
API designers != end users
API

22. What devs expect
@nico_gBeginner Expert
How does it
work?
Performance
design
Performance
Many languages
API reference
Community
Simplicty
Quickstart
Support
Wow effect Examples

23. @nico_g
time
difficulty
supportdev
Bad DX

24. First impression matters
@nico_g
Documentation

25. @nico_g
Documenting your API is
easy

26. @nico_g
Swagger.io
Top-down
1. Create a Swagger
definition of your API
2. Generate Server
implementation
1. You already have a
REST API
2. Generate the Swagger
definition
Bottom-up

27. @nico_g

28. @nico_g

29. READING DOCS
@nico_g
LOL

30. ⌘C + ⌘V
@nico_g
PRAG-MA-TISM

31. @nico_g
Don’t forget anyone
Code snippets

33. @nico_g
Don’t forget anyone
Code snippets User guides

34. @nico_g

35. @nico_g
Don’t reinvent the wheel
apiary
readme.io
slate

36. Don’t reinvent the wheel

37. @nico_g
Don’t forget anyone
Code snippets User guides Sample app

39. while (true) {
repeat();
}
@nico_g

40. @nico_g
{ }
js-doc.md php-doc.md go-doc.md
</>
metadata
code generator
templates

41. @nico_g
{
"description" : "This call sends an email.",
"resource" : "send",
"action" : "POST",
"args" : [
…
}

42. @nico_g
{{#filtersExist}}
$filters = [
{{#filters}}
'{{name}}' => '{{value}}'{{#comma}},{{/comma}}
{{/filters}}
];
{{/filtersExists}}
{{#argumentsExist}}
$body = {{{body}}};
{{/argumentsExist}}

43. @nico_g
{
"Count": 1,
"Data": [
{
{{#args}}
"{{name}}":"{{value}}"{{#comma}},{{/comma}}
{{/args}}
}
],
"Total": 1
}

44. @nico_g
Paw-some!

45. @nico_g

46. @nico_g

47. Developer Advocate
@nico_g
Connect with devs
and help them make
the most of your
APIs
Share knowledge
at conferences,
meetups &
hackathons
Design and provide
sample code for
developers to
make their use of
the API easy
work on fun projects
to show what your API
is capable of

48. @nico_g
Questions?
ngarnier@mailjet.com

49. @nico_g
Thanks.
ngarnier@mailjet.com