4 ms·
I'm building a public API in my current job and, a few weeks ago, I was scouting around for the good API design advice. Absolutely far and away the best resourc
by philbo 15y ago
I'm building a public API in my current job and, a few weeks ago, I was scouting around for the good API design advice. Absolutely far and away the best resource that I found was this Google TechTalk by Joshua Bloch:
http://www.youtube.com/watch?v=aAb7hSCtvGw 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.
- tomgallard 15y agoBuilding the API for Pwinty (http://www.pwinty.com 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 http://www.dropbox.com/developers/reference/api All the resources are documented in the same way, it is nicely formatted, and easy to understand.
- masklinn 15y agoParse'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://blog.parse.com/2012/01/11/designing-great-api-docs/