9 comments

[ 4.7 ms ] story [ 30.6 ms ] thread
I'm somewhat biased but after looking long and hard for a good rest documentation system, i think this is the right way to do it.
I may be preaching to the choir here, but you should really read these docs.
The "Try it out" feature is 7 ways of awesome.
Could use a little more context, examples etc. Good but not perfect.
Indeed. My initial thought was "WTF is wordnik and why should I care?" A good landing page should answer these questions.
What's a good example of "perfect" API documentation?
I agree, the site as a whole would benefit from those. But I was referring to the documentation for each API call, and specifically the way you can make test calls to the API from within the docs themselves. I've seen API sandboxes before, but as far as I know this style of combining docs with live test calls is unique.
Stockpoint did this with all their web APIs 5 years ago...
Agreed. And if I remember correctly, the previous version DID have examples.