Ask HN: What's the best API documentation you've ever seen?

https://news.ycombinator.com/item?id=6224155

by jpswade • 13 years ago

4 8 13 years ago

news.ycombinator.com

What works best for you?

anaphor• 13 years ago

Does language documentation count? If so, http://docs.racket-lang.org/ is probably as good as it gets.

danso• 13 years ago

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

yogo• 13 years ago

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.

gfreeman• 13 years ago

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

tsl_hacker• 13 years ago

stripe docs

Navarr• 13 years ago

In PHP I generally use a framework called Yii. Their documentation is amazing: http://www.yiiframework.com/doc/api/1.1/CActiveDataProvider

6thSigma• 13 years ago

I think Parse has really great documentation.

jpswade• 13 years ago

http://developer.klout.com/io-docs

Ask HN: What's the best API documentation you've ever seen?

Related Stories