4 ms·
API docs done right
- fehguy 16y agoI'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.
- hobbeswalsh 16y agoI may be preaching to the choir here, but you should really read these docs.
- markwvh 16y agoThe "Try it out" feature is 7 ways of awesome.
- JoeAltmaier 16y agoCould use a little more context, examples etc. Good but not perfect.
- cabalamat 16y agoIndeed. My initial thought was "WTF is wordnik and why should I care?" A good landing page should answer these questions.
- hobbeswalsh 16y agoWhat's a good example of "perfect" API documentation?
- johnny99 16y agoI 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.
- JoeAltmaier 16y agoStockpoint did this with all their web APIs 5 years ago...
- isnotchicago 16y agoAgreed. And if I remember correctly, the previous version DID have examples.