API Design

Internal team share

Transcript

1. #apidesign {"name":"ferrari","location":"Yahoo", "date":2011/07/11,"contact":"@ferrari_tw"}
2. http://jamessiminoff.com/post/1661130398/api- first-mobile-second-web-third-the-most API First, Mobile Second, Web Third OpenX
3. of Twitter traffic comes in through third-party applications 75%
4. of Twitter's active users tweet from the phones 37%
6. Good API •Easy to learn •Easy to use, even without documentation •Hard to misuse •Easy to read and maintain code that uses it •Sufficiently powerful to satisfy requirements •Easy to extend •Appropriate to audience
7. SOAP v.s. REST http://broadcast.oreilly.com/2011/06/the- good-the-bad-the-ugly-of-rest-apis.html
8. https://twitter.com/#!
9. Which One Is the BEST? http://api.twitter.com/version/statuses /public_timeline.format https://api.foursquare.com/v2/venues/add http://api.flickr.com/services/rest/?method=flickr.photos. search &format=json&nojsoncallback=1 http://wretch.yahooapis.com/v1.2/blogService /{guid|wid}/articles
10. 2 URL + CRUD Sweep Complexity behind the '?'
11. Twitter REST API http://api.twitter.com/version /statuses /public_timeline.format ?trim_user=true
12. How about errors?
13. How about errors? HTTP Code http://en.wikipedia.org/wiki/List_of_HTTP_status_codes Code for code Message for People
14. How about Exception Client Intercepts HTTP Code... twitter ?suppress_response_codes=true code: 200 {"response_code":"401", "message"...} http://dev.twitter.com/pages/every_developer
15. How About Testing? PHPUnit!?
16. RESTeasy To test RESTful APIs in node.js and Javascript Reduce the number of lines of test code required to fully cover all primary and edge use cases of a given API over HTTP http://blog.nodejitsu.com/rest-easy-test-any-api-in- nodejs
17. System Requirement Server x 1 (Linux better) Boring Engineer x 1 NodeJS More NodeJS
18. is not Javascript it is C
19. Live Demo 挖低加
20. Resources How To Design A Good API and Why it Matters http://www.youtube.com/watch?v=aAb7hSCtvGw http://blog.apigee.com/detail /video_restful_api_design_pragmatic_not_dogmatic/ http://vimeo.com/23861183 http://mobile.baselinemag.com/c/a/Business- Intelligence/25-Fast-Facts-About-Twitter-in-the- Workplace-212013/
21. Resources http://techcrunch.com/2011/01/12/youtube-mobile- traffic-tripled-in-2010-android-app-gets-music-videos-and- ads/