News for hackers. Stuff that matters.

A comment on An API is only as good as its documentation. Parent comment

Re:An API is only as good as its documentation by timjones on Monday March 30, 2015 @12:00PM (#9290386)
Definitely check out http://readme.io. Their docs look beautiful and set-up is a breeze.
[ Parent | on HN ]
Re:An API is only as good as its documentation by gdillon on Monday March 30, 2015 @02:13PM (#9291406)
Thanks for the tip, Tim! Happy to answer any questions folks have about my product.

Also, plugging: Swagger support in just a few weeks. And we can currently auto generate endpoint reference docs from your source code using a commenting standard similar to javadoc.

We get all sorts of excited by good API documentation. Weird, right? Apparently not, based on this thread. :D

[ Parent | on HN ]