Ask HN: How do you write documentation for your public APIs?

4 pointsby nahcub13 lat temu4 comments

Do you know of any good programs? Do you simply use a Markdown or RST document? Or do you know of something even better?

Thanks!

3 comments

bosky10113 lat temu

Wordnik's swagger comes to mind

https://developers.helloreverb.com/swagger/

We just launched our own api ( handwritten with bootstrap,css )

check it out at http://appetite.io/docs

~B

hhandoko13 lat temu

+1 for Swagger.

I'm predominantly .Net, and Swagger support for the ServiceStack[1] libraries has been very handy!

[1] http://servicestack.net/

trevoro13 lat temu

I really like using Restdown https://github.com/trentm/restdown

It's markdown with a few more conventions. Really handy.

swah13 lat temu

Python has Sphinx, used by almost every big package.