News for hackers. Stuff that matters.
Re:Ask HN: What's the best API documentation you've ever seen? by danso on Friday August 16, 2013 @10:36AM (#6224222)
The formatting and styling is a little dated and claustrophobic, but I always liked how thoroughly (with plentiful links to convenient test examples and a dev console) the New York Times documented their APIs: http://developer.nytimes.com/docs/congress_api
Re:Ask HN: What's the best API documentation you've ever seen? by anaphor on Friday August 16, 2013 @10:32AM (#6224197)
Does language documentation count? If so, http://docs.racket-lang.org/ is probably as good as it gets.
Re:Ask HN: What's the best API documentation you've ever seen? by gfreeman on Friday August 16, 2013 @11:18AM (#6224482)
I've always found Qt's docs very usable: http://qt-project.org/doc/qt-5.1/qtwidgets/qmainwindow.html

Also, although not an API, the diagrams in the SQLite docs are extremely helpful in structuring statements: http://www.sqlite.org/lang_createtable.html

Re:Ask HN: What's the best API documentation you've ever seen? by yogo on Friday August 16, 2013 @10:58AM (#6224358)
I like the way the Stripe documentation is done. I've seen other tools/libs use a similar format but I'm not sure what the underlying doc generator is.
Re:Ask HN: What's the best API documentation you've ever seen? by Navarr on Friday August 16, 2013 @11:29AM (#6224576)
In PHP I generally use a framework called Yii. Their documentation is amazing: http://www.yiiframework.com/doc/api/1.1/CActiveDataProvider
Re:Ask HN: What's the best API documentation you've ever seen? by jpswade on Saturday August 17, 2013 @10:50AM (#6229221)
Re:Ask HN: What's the best API documentation you've ever seen? by 6thSigma on Friday August 16, 2013 @11:34AM (#6224625)
I think Parse has really great documentation.
Re:Ask HN: What's the best API documentation you've ever seen? by tsl_hacker on Friday August 16, 2013 @11:20AM (#6224493)
stripe docs