• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Art of Building APIs
 

Art of Building APIs

on

  • 1,305 views

My short talk on problems designing and building successful APIs, presented first at API Strategy Conference in New York

My short talk on problems designing and building successful APIs, presented first at API Strategy Conference in New York

Statistics

Views

Total Views
1,305
Views on SlideShare
1,005
Embed Views
300

Actions

Likes
2
Downloads
21
Comments
0

3 Embeds 300

http://www.apistrategyconference.com 230
http://apistrategyconference.com 35
http://www.3scale.net 35

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

    Art of Building APIs Art of Building APIs Presentation Transcript

    • THE ART OF BUILDING APIS Jakub Nesetril founder & CEO of Apiary
    • ONE SIZE DOES NOT FIT ALL There is no simple way to solve API design. Different groups of developers has different needs, usecases and workflows.
    • ART, NOT ROUTINE API is and interface. In 2000’s, we thought it was machine- machine interface. But in 2010’s, we know that it’s the interface to the developer behind the machine. Thus, building APIs is a lot like building UIs.
    • UI design is dominatedby user-centered design.It involves the user intodesign workflow as soonas possible, often usingwireframes.
    • But API design is stilllargely a waterfallapproach - design-build-document everythingupfront. Only theninvolve the user.
    • Mock > Use > ImplementUsing a mock serverallows to change theworkflow: produce awireframe quickly, theninvolve the customer.Implement once the apiary.iodesign is finalized.
    • Mock > Use > ImplementUsing a mock serverallows to change theworkflow: produce awireframe quickly, theninvolve the customer.Implement once the apiary.iodesign is finalized.
    • API BLUEPRINTHOST: http://api.twitter.com/ Apiary.io has a quick--- Twitter API 3.0 --- tool for describing APIs--- using a very light-weight DSL called APIWelcome to our API. Comments support Markdown syntax Blueprint.----- Retrieve Tweets --GET /tweets> Accept: application/json< 200< Content-Type: application/json{ "items": [ { "url": "/feed", "range":"2ZY48XPZ", "quantity": 1, "name": "Newsocks", "price": 1.25 }] }
    • Mock > Use > Implement Using this more structured approach gives you more benefits at once. Once you finish designing, your documentation and test suite are in sync.Testing Documentation apiary.io
    • TESLA MODEL SAmong other APIsthat weredocumented inApiary was TeslaModel S.
    • apiary.ioE-MAIL jakub@apiary.io TWITTER @apiaryio
    • PHOTO CREDITShttp://www.flickr.com/photos/ironrodart/4308675209/sizes/o/http://www.flickr.com/photos/30030574@N03/3633431964/