3 ms·
Ask HN: What's the best API documentation you've ever seen?
What works best for you?
- anaphor 13y agoDoes language documentation count? If so, http://docs.racket-lang.org/ http://docs.racket-lang.org/ is probably as good as it gets.
- danso 13y agoThe 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 http://developer.nytimes.com/docs/congress_api
- yogo 13y agoI 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 13y agoI've always found Qt's docs very usable: http://qt-project.org/doc/qt-5.1/qtwidgets/qmainwindow.html 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 http://www.sqlite.org/lang_createtable.html
- deleted 13y ago[deleted]
- tsl_hacker 13y agostripe docs
- Navarr 13y agoIn PHP I generally use a framework called Yii. Their documentation is amazing: http://www.yiiframework.com/doc/api/1.1/CActiveDataProvider http://www.yiiframework.com/doc/api/1.1/CActiveDataProvider
- 6thSigma 13y agoI think Parse has really great documentation.
- jpswade 13y agohttp://developer.klout.com/io-docs http://developer.klout.com/io-docs