Re:API Design is UI for Developers
by tomgallard on Sunday March 04, 2012 @11:55AM
(#3663120)
Building the API for Pwinty (http://www.pwinty.com) I found the Dropbox API docs to be a really good example of how to structure your documentation - http://www.dropbox.com/developers/reference/api
All the resources are documented in the same way, it is nicely formatted, and easy to understand.
Parse's blog has a pretty good article on documenting APIs[0], with links to a number of nicely one API documentations (not dropbox's, but Github's, Stripe's, Backbone's, Mailgun's and their own)
[0] http://blog.parse.com/2012/01/11/designing-great-api-docs/
http://www.youtube.com/watch?v=aAb7hSCtvGw
If you're interested in the topic and haven't seen it yet, I urge you to do so ASAP.