Building Successful APIs Overnight!

Transcript

1. Nik Wakelin @nikz
2. API Tools
3. D E V E LO PI N G SU CCE S S FU L AP I s OVERNIGHT!
5. D E V E LO PI N G SU CCE S S FU L AP I s VIA INCREMENTAL AND SUSTAINED EFFORT OVER MANY MONTHS AND PERHAPS EVEN YEARS!!
6. (It won’t happen overnight, but it will happen) D E V E LO PI N G SU CCE S S FU L AP I s
7. 1. Make 2. Market 3. Maintain
8. MAKE
9. do we even WANT an API?
11. £THE AP I YO U NEVER BUILD WO N’T CO ST YOU ANY MONEY! ¥ €
12. Who can we copy?
13. ok, WE’RE IN!
15. BEWARE THE IVORY TOWER
16. X X MURDER THE UNICORNS MURDER
17. YOUR API IS UNICORN NOT A
19. YOUR API IS JUST LIKE ANY OT HER FEATURE
20. Iterate, Iterate, Iterate
21. Start SMALL then go BIG
22. LISTEN and ADJUST
23. time to TALK TECH
24. Architecture REST SOAP RPC
25. just use REST Simple & Natural Cacheable Plays nicely with HTTP
26. Resource Anatomy https://rugbywc.com/api/teams/all-blacks Domain
27. Resource Anatomy https://rugbywc.com/api/teams/all-blacks Namespace
28. Resource Anatomy https://rugbywc.com/api/teams/all-blacks Resource
29. Resource Anatomy https://rugbywc.com/api/teams/all-blacks Identifier
30. think nouns: /api/get_emails_for/bob /api/users/bob/emails.json
31. use verbs: POST PATCH PUT GET DELETE HEAD, OPTIONS, …
32. don’t forget about headers: Rate Limiting Caching (ETag, Cache-Control) Ranges (Pagination) API Version?
33. Responses
34. { "type": "car", "name": "My Ferrari", "cylinders": 512, "options": { "seats": 4, "turbospeed": 360 }, "allowedpassengers": { "family": ["Alice", "Bob"], "friends": ["Charlie", "Diana"] } } <car xmlns:xs="http://www.w3.org/2001/XMLSchema"> <name type="xs:string">My Ferrari</name> <cylinders type="xs:int">48</cylinders> <optionals> <seats type="xs:int">4</seats> <turbospeed type="xs:int">360</turbospeed> </optionals> <allowedpassengers> <devices type="xs:list"> <device type="xs:string">cdrom</device> <device type="xs:string">harddisk</device> </allowedpassengers> </boot> </vm> > JSON XML
36. JSON API http://jsonapi.org { "data": { "type": "cars", "id": "48", "attributes": { "seats": 4, "turbospeed": 360 }, "relationships": { "allowedpassengers": { // ... } } } }
37. { post: { id: 211, title: 'Dog Bites Man', author: 'Nik Wakelin', _links: [ { rel: 'comments.new', href: 'posts/211/comments/new' } ] } HATEOAS
38. errors!
39. { message: "Your caffeine level is too low, try a double espresso!", more_link: "https://developer.yourapi.com/errors/123" } HTTP 1.1 400 Bad Request
40. authentication: OAuth (2.0) HTTP Basic Token (Header, Query)
41. NEVER, EV ER INVENT YOUR OWN AUTH!
42. I’ll quickly hack up a client for this custom auth… 401 401 401 401 401 401 401 401 401 401 401 401 401
43. NEVER, EV ER INVENT YOUR OWN AUTH!
44. oauth 2.0: Good Library Support Plenty of Grant Types Can be hard to get your head around…
45. http basic or API Key Very Simple Revocation? No Application Level Config
46. skip it entirely! https://getkong.org
47. Fake it ‘till you make it! Mock Proxies! http://mockbin.org https://github.com/basicallydan/interfake
48. MARKET
49. Developer Experience “DX”
50. Who can we copy?
51. Docs, Docs, AND MORE DOCS!
52. docs essentials: “Getting Started” API Reference (Sample Code) Explorer (Try it out!) Registration
53. Developer
54. Recipes!
55. https://stripe.com/docs/ “Stripe-style” 3-column
56. Travis CI Top-Notch Narrative Docs docs.travis-ci.com
57. Digital Ocean Community digitalocean.com/community
58. Gelato! https://gelato.io
59. Definition Languages swagger.io apiblueprint.org
60. "/pet":{ "post":{ "summary":"Add a new pet to the store", "parameters":[ { "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } } ], "responses":{ "405":{ "description":"Invalid input" } }, // ... swagger.io
61. GET MOR E DEV S BY SPEAKING THEI R LANGUAGE
62. Client Libraries - SDKs - Dev Kits + Sample Code!
63. SDK creation Reference Implementation Unirest, HTTParty APIMatic.io Outsource
65. Events!
66. get your swag sorted Stickers (Stickermule) T-Shirts (make ‘em nice!) Coupons & Discounts
67. hackathons make sure your devs are there! great way to help people fun integrations to tweet
68. hiring! (sssh!)
69. (“Mondometer” by @simonvc)
70. hackathons short-term focus effort to organise
71. MA I NTA I N
72. Update. Communicate. …and Mature(ate)
73. Update!
74. Versioning https://rugbywc.com/api/v1/teams
75. Versioning Do your best not to break anything …but don’t stand still.
76. 410 GONE
77. analyse and improve Response Times Uptime (Status Page) Errors
78. collect data https://apianalytics.com
79. Communicate!
80. @YourCoAPI
81. slack.com
82. gitter.im
83. “Traditional”…
84. Mature…
85. Last Updated: 3 years ago
86. DON’T FO RG ET TO SHOW OFF!
87. Xero Add-On Directory Marketplace xero.com/add-ons
88. Help your API developers make money.
89. Help your API developers build businesses.
90. INTEG RATIONS C AN BE A MAJOR COMPETI TIVE ADVANTAGE
91. BE VERY CAREFUL OF ACQUISITIONS
92. IN SHORT, FOR AN AMAZING API YOU NEED TO…
93. X X MURDER THE UNICORNS MURDER
94. Developer GREAT STORY TELL A
95. KEEP IT UP!
96. DON’T EXPECT IT TO HAPPEN OVERNIGHT
97. Nik Wakelin @nikz
98. Image Credits Switch from Marcin Wichary on Flickr (https://www.flickr.com/photos/mwichary/2356651346) Blocks from Holger Zscheyge on Flickr (https://www.flickr.com/photos/zscheyge/49012397) Unicorn from (https://thenounproject.com/search/?q=unicorn&i=9584) Sign from John McLinden on Flickr (https://www.flickr.com/photos/fogey03/16838534116/) (Bad Photoshop is all me) Unicorn cupcake from kirstin_b on flickr (https://www.flickr.com/photos/kristinausk/4121781145/) Shape Sorter from SpAvAAi on Flickr https://www.flickr.com/photos/spavaai/2536426227/ Disconnected Phone from mrdarkroom on Flickr https://www.flickr.com/photos/mrdarkroom/5357276454 Leaning Tower from Kit on Flickr (https://www.flickr.com/photos/practicalowl/18648955463/) Crane from Nicolás Boullosa on Flickr (https://www.flickr.com/photos/faircompanies/20519433104/) Clown Fish & Blue Tang from Iooyaa on Flickr (https://www.flickr.com/photos/58196275@N04/8636837527/) Cookies from george.bremer on Flickr (https://www.flickr.com/photos/ghbremer/5276304808) ❤
99. Image Credits Seedling from lev-shine on Flickr https://www.flickr.com/photos/kevinshine/9984357243/) Beer from Alan Levine on Flickr (https://www.flickr.com/photos/cogdog/21127813750) Airshow by Pavel N from the Noun Project Abandoned Six Flags from Darrell Miller on Flickr (https://www.flickr.com/photos/darrellrhodesmiller/6904703505) Tui Bird from Cat Burton on Flickr (https://www.flickr.com/photos/catburton/16023893948/) Mailboxes from Olga Caprotti on Flickr (https://www.flickr.com/photos/__olga__/2822660113/) Lock by Michael Martinho from the Noun Project Key by John Caserta from the Noun Project User by Wilson Joseph from the Noun Project Loudhailer from Lis Ferla on flickr (https://www.flickr.com/photos/lastyearsgirl_/3537374056/) Linux Kernel Baby from Harald Groven on flickr (https://www.flickr.com/photos/kongharald/13242684424) Rainbow Tiles from Steve Snodgrass on Flickr (https://www.flickr.com/photos/stevensnodgrass/6807424348) Empty Classroom from KT King on Flickr (https://www.flickr.com/photos/xtrah/4853491803/) Cycle Hire from Kirk Siang on Flickr (https://www.flickr.com/photos/kirksiang/6180888330) ❤