Ask HN: What tools do you use for HTTP/Rest API documentation?

3 points

13 years ago

I have been us Sphinx[1] along with sphinxcontrib-httpdomain[2], and the results seem "ok", but I find the reStructuredText syntax to be awkward and cumbersome. I would vastly prefer something markdown based.

I have considered Groc[3], because I think the Stripe[4] api docs are awesome and it seems like literate style api documentation could be a big win for maintainability as well as readability, but was wondering if there are better known alternatives.

What tools do you use for maintaining api docs?

  [1]: https://stripe.com/docs/api
  [2]: http://pythonhosted.org/sphinxcontrib-httpdomain/
  [3]: https://github.com/nevir/groc
  [4]: https://stripe.com/docs/api

5 comments