Tweet
Tweet

Slide 1

Slide 1 text

nik wakelin

Slide 2

Slide 2 text

@nikz

Slide 3

Slide 3 text

we need to TALK about DOCS

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

gelato.io

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

we could be doing so. much. better

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

avoid

Slide 12

Slide 12 text

avoid assume

Slide 13

Slide 13 text

avoid assume abandon

Slide 14

Slide 14 text

avoid assume abandon abbr.

Slide 15

Slide 15 text

AVOID

Slide 16

Slide 16 text

the only “self-documenting” interface

Slide 17

Slide 17 text

HATEOAS

Slide 18

Slide 18 text

HATEOAS

Slide 19

Slide 19 text

“intern! heel!”

Slide 20

Slide 20 text

cherry on top

Slide 21

Slide 21 text

AVOID

Slide 22

Slide 22 text

AVOID EMBRACE!

Slide 23

Slide 23 text

require great docs great effort

Slide 24

Slide 24 text

HATEOAS why the nik?

Slide 25

Slide 25 text

making life easy for yourself at the expense of your developers!

Slide 26

Slide 26 text

map? don’t your developers deserve a

Slide 27

Slide 27 text

0 ∞ N(API requests) humans computers!

Slide 28

Slide 28 text

complexity

Slide 29

Slide 29 text

“guided” client make HTTP request deal with response

Slide 30

Slide 30 text

“D.E.Y.” client make HTTP request follow links caching? handle HTTP 410 deal with response & etc.. & etc…

Slide 31

Slide 31 text

season with metadata pagination, webhooks…

Slide 32

Slide 32 text

No content

Slide 33

Slide 33 text

ASSUME

Slide 34

Slide 34 text

devs code! ===

Slide 35

Slide 35 text

swagger-ui time for a beer!

Slide 36

Slide 36 text

ASSUME

Slide 37

Slide 37 text

ASSUME UNDERSTAND

Slide 38

Slide 38 text

your devs you your API client code

Slide 39

Slide 39 text

your devs you your API client code '!

Slide 40

Slide 40 text

lost translation in

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Swagger / OAI, API Blueprint, RAML…

Slide 43

Slide 43 text

Swagger / OAI, API Blueprint, RAML… (a good start)

Slide 44

Slide 44 text

what is important, but don’t forget why?

Slide 45

Slide 45 text

speak human! speaking to humans?

Slide 46

Slide 46 text

better together

Slide 47

Slide 47 text

guides are just recipes

Slide 48

Slide 48 text

always be testing!

Slide 49

Slide 49 text

No content

Slide 50

Slide 50 text

ABANDON

Slide 51

Slide 51 text

last updated never

Slide 52

Slide 52 text

support “forum”

Slide 53

Slide 53 text

No content

Slide 54

Slide 54 text

ABANDON

Slide 55

Slide 55 text

ABANDON MAINTAIN

Slide 56

Slide 56 text

No content

Slide 57

Slide 57 text

No content

Slide 58

Slide 58 text

your API is just like any other feature

Slide 59

Slide 59 text

avoid the big bang!

Slide 60

Slide 60 text

No content

Slide 61

Slide 61 text

No content

Slide 62

Slide 62 text

monitor

Slide 63

Slide 63 text

No content

Slide 64

Slide 64 text

ABBR.

Slide 65

Slide 65 text

P D F retty ead ormat

Slide 66

Slide 66 text

list of endpoints how to authenticate 200 OK 201 CREATED

Slide 67

Slide 67 text

list of endpoints how to authenticate 200 OK 201 CREATED 299 TIME FOR A BEER?

Slide 68

Slide 68 text

No content

Slide 69

Slide 69 text

ABBR.

Slide 70

Slide 70 text

ABBR. EXPAND

Slide 71

Slide 71 text

what delivery does your say?

Slide 72

Slide 72 text

No content

Slide 73

Slide 73 text

developer.yourapp.com

Slide 74

Slide 74 text

No content

Slide 75

Slide 75 text

No content

Slide 76

Slide 76 text

who is using my API?

Slide 77

Slide 77 text

@yourapi

Slide 78

Slide 78 text

slack.com

Slide 79

Slide 79 text

gitter.im

Slide 80

Slide 80 text

talk!

Slide 81

Slide 81 text

xero.com/add-ons

Slide 82

Slide 82 text

No content

Slide 83

Slide 83 text

done? when am I API Explorer, Credential Management, Dev Registration, Account Dashboard, (good!) search, …

Slide 84

Slide 84 text

(never)

Slide 85

Slide 85 text

No content

Slide 86

Slide 86 text

No content

Slide 87

Slide 87 text

EMBRACE effort

Slide 88

Slide 88 text

help your developers UNDERSTAND

Slide 89

Slide 89 text

keep up the good work! MAINTAIN

Slide 90

Slide 90 text

do more for your devs! EXPAND

Slide 91

Slide 91 text

go out there and CREATE amazing EXPERIENCES

Slide 92

Slide 92 text

gelato.io

Slide 93

Slide 93 text

getgalileo.io

Slide 94

Slide 94 text

getkong.org

Slide 95

Slide 95 text

thanks!

Slide 96

Slide 96 text

nik wakelin

Slide 97

Slide 97 text

@nikz

Slide 98

Slide 98 text

[email protected]

Slide 99

Slide 99 text

thanks! Pipes, Isado (https://www.flickr.com/photos/isadocafe/ 3268348703) Tui Bird, Cat Burton (https://www.flickr.com/photos/ catburton/16023893948/) Mailboxes, Olga Caprotti (https://www.flickr.com/photos/ __olga__/2822660113/) Delivery Man, Chris Bird (https://www.flickr.com/photos/ 118292762@N02/15475876255) Tools, Paul Downey (https://www.flickr.com/photos/psd/ 5298483) Kittens, abcrumley (https://www.flickr.com/photos/ crumley/160490011/) M82 Galaxy, Stuart Rankin (https://www.flickr.com/ photos/24354425@N03/12808714524/) Wrong Way, David Goehring (https://www.flickr.com/ photos/carbonnyc/7777982086) Neuschwanstein, Markus Jaschke (https://www.flickr.com/ photos/schomy/22547613404) Tumbleweed, USFS Mountain-Prairie (https:// www.flickr.com/photos/usfwsmtnprairie/13981953730/)

Slide 100

Slide 100 text

thanks! Tokyo Signs from Anton G (https://www.flickr.com/ photos/s7stem/2645936875/) Secret Bunker, Marcomo (https://www.flickr.com/ photos/marcmos/3674715600) Baby with Bottle, David Precious (https:// www.flickr.com/photos/bigpresh/10176739514/) Weightlifting, Singapore 2010 (https:// www.flickr.com/photos/singapore2010/4897930037/) Coffee from Linh Nguyen (https://www.flickr.com/ photos/lng0004/15541408139/) Gimme a Boost, Brittney Bush Bollay (https:// www.flickr.com/photos/tzofia/843491313) Sundae, Thomas Hawk (https://www.flickr.com/ photos/thomashawk/2500262938) Tourist Reading Map, Pedro Ribeiro Simões (https:// www.flickr.com/photos/pedrosimoes7/8150135751/in/) Indian Spices, Sara Marlowe (https:// www.flickr.com/photos/saramarlowe/8170948596/) OK Diner, Andrew Bartram (https://www.flickr.com/ photos/warboyssnapper/6780082962)

Slide 101

Slide 101 text

thanks! Run Down House, Henning Klokkeråsen (https:// www.flickr.com/photos/photohenning/20879839580/) Play House, Paul Sableman (https://www.flickr.com/ photos/pasa/16410623154) Straya from Jes (https://www.flickr.com/photos/ mugley/307473865/) Red Bull in, Code Out from Tahir Hashmi (https:// www.flickr.com/photos/code_martial/2501920341/) Oscilliscope, Eli Brody, (https://www.flickr.com/ photos/coldphage/3535410747) Exams, Cushing Memorial Library (https:// www.flickr.com/photos/cushinglibrary/3607496812) Why?, Katy Sayer (https://www.flickr.com/photos/ ksayer/5614813544/) Complexity, Mark Skipper (https://www.flickr.com/ photos/bitterjug/7670055210/)

Slide 102

Slide 102 text

?