面向用户的 API 文档

你们一般用什么工具生成面向用户的 API 文档？

以下为引用，共大家参考，内容为主，工具为辅。

• swagger
• sphinx-doc
• GitHub markdown
• API Blueprint
• GitBook
• doxygen/javadoc

不过都不是很成熟，各种坑，达不到 doxygen/javadoc 这种成熟度。另，面向客户的 API 文档，我建议参考下 stripe 的 API 文档 stripe api ，类似工具：slate

貌似现在城里人都在用 swagger，但是我还在土土地用 sphinx-doc 和 GitHub markdown - 松鼠奥利奥
我们用 swagger - VeryCB
swagger 有办法像 sphinx-doc 那样写 docstring 里么… 感觉单独维护一套很容易一不小心就不一致了… - 松鼠奥利奥
Swagger / API Blueprint 都试用过，现在决定用 GitBook 手写 - E.T
@VeryCB 怎样生成好看的 HTML? - E.T
@VeryCB 同问怎么定制样式 …… 最好可以方便给前端集成 - satoru
Swagger UI 的 parser 跟 shi 一样的，跟 Swagger Editor 的解析很多不一致 😓 - E.T
swagger - georgexsh
居然这么多人用 swagger - su27根本就没有
除了 swagger 记得还有另一个 specification，都一副半成品的样子 …… - satoru
swagger，还有个 raml - xiaohanyu
不过都不是很成熟，各种坑，达不到 doxygen/javadoc 这种成熟度。另，面向客户的 API 文档，我建议参考下 stripe 的 API 文档 https://dou.bz/0XbFzR ，类似工具：https://dou.bz/2eRlot 。 - xiaohanyu