Settings

Theme

Ask HN: What have you used to document your public API?

2 points by richardv 12 years ago · 2 comments · 1 min read


Self-explanatory.

What tools/resources/docgens/services have you used to provide documentation for your public facing API services that you are providing to customers.

johns 12 years ago

I prefer hand-written. But other people like Swagger https://developers.helloreverb.com/swagger/, I/O Docs https://github.com/mashery/iodocs, Daux (although this is just a style framework) http://daux.io/ and http://apiary.io/

angersock 12 years ago

We use a wiki (Dokuwiki) for internal docs, probably going to either make it public or perhaps switch over to Daux.io once I'm satisfied it doesn't hate America.

Keyboard Shortcuts

j
Next item
k
Previous item
o / Enter
Open selected item
?
Show this help
Esc
Close modal / clear selection