Agile API development with apiary.io

What problem apiary.io solves? Pres + live coding for pyvec python meetup.

Transcript

1. Bee at Apiary Lukas Linhart AGILE API DEVELOPMENT WITH APIARY.IO
2. GitHub for APIs apiary.io
3. WHY WE DO THINGS • documentation and tooling, not architecture • man-years of API infrastructure work • companies & teams re-inventing the wheel
5. API DESIGN
12. API DESIGN REIMAGINED
14. 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 } ] } API BLUEPRINT
15. MOCK SERVER
18. apiary.io Mock > Use > Implement
19. DOCUMENTATION
20. #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?
21. DOCUMENTATION REIMAGINED
22. DOCUMENTATION • includes runnable code examples (NOT API console) • is backed up by automated tests (never out of date)
24. SUPPORT
25. #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…
26. SUPPORT REIMAGINED
27. SUPPORT • includes self-service debugger • API support requests routed directly to devs with debugging information included
29. apiary.io Mock > Use > Implement Documentation Automated Testing
30. http://github.com/apiaryio http://support.apiary.io/ COME HELP US
31. E-MAIL lukas@apiary.io TWITTER @apiaryio Q&A
32. CREDITS This presentation is shamelessly reused http://www.slideshare.net/jakub.nesetril/avoiding-api-waterfalls All creation credits go to Jakub ;) 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/