API docs done right

http://developer.wordnik.com/docs

by johnny99 • 15 years ago

14 9 15 years ago

developer.wordnik.com

fehguy• 15 years ago

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.

hobbeswalsh2• 15 years ago

I may be preaching to the choir here, but you should really read these docs.

markwvh• 15 years ago

The "Try it out" feature is 7 ways of awesome.

JoeAltmaier2• 15 years ago

Could use a little more context, examples etc. Good but not perfect.

cabalamat• 15 years ago

Indeed. My initial thought was "WTF is wordnik and why should I care?" A good landing page should answer these questions.

hobbeswalsh2• 15 years ago

What's a good example of "perfect" API documentation?

johnny99• 15 years ago

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.

JoeAltmaier2• 15 years ago

Stockpoint did this with all their web APIs 5 years ago...

isnotchicago• 15 years ago

Agreed. And if I remember correctly, the previous version DID have examples.

API docs done right

Related Stories