Avoiding API Waterfalls
Upcoming SlideShare
Loading in...5
×
 

Avoiding API Waterfalls

on

  • 3,354 views

 

Statistics

Views

Total Views
3,354
Views on SlideShare
3,207
Embed Views
147

Actions

Likes
7
Downloads
29
Comments
0

7 Embeds 147

https://twitter.com 79
http://eventifier.co 33
http://lanyrd.com 26
http://www.feedspot.com 5
https://twimg0-a.akamaihd.net 2
http://localhost 1
http://feedly.com 1
More...

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Avoiding API Waterfalls Avoiding API Waterfalls Presentation Transcript

    • AVOIDING WATERFALLS Jakub Nesetril founder & CEO of ApiaryTuesday, December 4, 12
    • apiary.io GitHub for APIsTuesday, December 4, 12
    • WHY WE DO THINGS • documentation and tooling, not architecture • man-years of API infrastructure work • companies & teams re-inventing the wheelTuesday, December 4, 12
    • 3 PROBLEMSTuesday, December 4, 12
    • API DESIGNTuesday, December 4, 12
    • WE START WITH WHITEBOARDTuesday, December 4, 12
    • THEN CODE THE DESIGNTuesday, December 4, 12
    • OFFER IT TO CUSTOMERSTuesday, December 4, 12
    • AND ALL FAILS, BADLYTuesday, December 4, 12
    • WHERE DID WE GO WRONG?Tuesday, December 4, 12
    • WATERFALL PROCESSTuesday, December 4, 12
    • API DESIGN REIMAGINED HOW CAN WE GO AGILE?Tuesday, December 4, 12
    • MAKE A DESIGN FIRSTTuesday, December 4, 12
    • BUT WRITE IT DOWN FOR ALL TO USE HOST: http://api.twitter.com/ --- Twitter API 3.0 --- --- Welcome to our API. Comments support Markdown syntax --- -- Retrieve Tweets -- GET /tweets > Accept: application/json < 200 < Content-Type: application/json { "items": [ { "url": "/feed", "range":"2ZY48XPZ", "quantity": 1, "name": "New socks", "price": 1.25 } ] }Tuesday, December 4, 12
    • OFFER A MOCK SERVERTuesday, December 4, 12
    • INVOLVE THE CUSTOMERTuesday, December 4, 12
    • CODE WITH SPEC TESTSTuesday, December 4, 12
    • Mock > Use > Implement apiary.ioTuesday, December 4, 12
    • DOCUMENTATIONTuesday, December 4, 12
    • #2: DOCUMENTATION • how do I make an HTTP call? • try to follow documentation but API behaves differently • is it invalid? is it outdated? am I doing it wrong?Tuesday, December 4, 12
    • DOCUMENTATION REIMAGINEDTuesday, December 4, 12
    • DOCUMENTATION • includes runnable code examples (NOT API console) • is backed up by automated tests (never out of date)Tuesday, December 4, 12
    • Tuesday, December 4, 12
    • SUPPORTTuesday, December 4, 12
    • #3: SUPPORT • my API calls are failing, no idea why • contacting customer support (that caters to shoe customers) • bumping my head against first-tier support for days until I get connected to developers • by that time, debug information is lost, logs are rotated, new product version is deployed…Tuesday, December 4, 12
    • SUPPORT REIMAGINEDTuesday, December 4, 12
    • SUPPORT • includes self-service debugger • API support requests routed directly to devs with debugging information includedTuesday, December 4, 12
    • Tuesday, December 4, 12
    • Mock > Use > Implement Automated Documentation Testing apiary.ioTuesday, December 4, 12
    • COME HELP US http://github.com/apiaryio http://support.apiary.io/Tuesday, December 4, 12
    • Q&A E-MAIL jakub@apiary.io TWITTER @apiaryioTuesday, December 4, 12
    • PHOTO CREDITS http://www.flickr.com/photos/ironrodart/4308675209/sizes/o/ http://www.flickr.com/photos/schlosi/6153707178/sizes/l/ http://www.flickr.com/photos/72153088@N08/6510934443/sizes/l/ http://www.flickr.com/photos/psd/3470234703/sizes/l/ http://www.flickr.com/photos/code_martial/2501920341/sizes/l/ http://www.flickr.com/photos/weesen/3589267112/sizes/l/ http://www.flickr.com/photos/weesen/3588454913/sizes/l/ http://www.flickr.com/photos/weesen/3589258380/sizes/l/ http://www.flickr.com/photos/polishsausagequeen/2178265710/ http://www.flickr.com/photos/stupidmommy/2649444581/sizes/z/Tuesday, December 4, 12