News for hackers. Stuff that matters.
Re:API docs done right by JoeAltmaier on Thursday February 10, 2011 @03:16PM (#2203519)
Could use a little more context, examples etc. Good but not perfect.
Re:API docs done right by johnny99 on Thursday February 10, 2011 @04:28PM (#2203834)
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.
Re:API docs done right by JoeAltmaier on Sunday February 13, 2011 @05:09PM (#2214123)
Stockpoint did this with all their web APIs 5 years ago...
Re:API docs done right by cabalamat on Thursday February 10, 2011 @03:45PM (#2203638)
Indeed. My initial thought was "WTF is wordnik and why should I care?" A good landing page should answer these questions.
Re:API docs done right by isnotchicago on Thursday February 10, 2011 @04:33PM (#2203862)
Agreed. And if I remember correctly, the previous version DID have examples.
Re:API docs done right by hobbeswalsh on Thursday February 10, 2011 @03:56PM (#2203677)
What's a good example of "perfect" API documentation?
Re:API docs done right by fehguy on Thursday February 10, 2011 @03:04PM (#2203463)
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.
Re:API docs done right by hobbeswalsh on Thursday February 10, 2011 @03:09PM (#2203486)
I may be preaching to the choir here, but you should really read these docs.
Re:API docs done right by markwvh on Thursday February 10, 2011 @03:13PM (#2203501)
The "Try it out" feature is 7 ways of awesome.