你们一般是用什么工具搭建自己的 API 文档？

2019-01-20 09:48:09 +08:00
 zhuzhibin

想找一些第三方的插件或者库，自己维护一套自己的项目文档，markdown 可能比较舒服

4148 次点击
所在节点    问与答
20 条回复
xiaomimei
2019-01-20 09:54:00 +08:00
https://swagger.io/tools/swagger-editor/
yiranHZT
2019-01-20 10:02:34 +08:00
后端 swagger、前端 JSDoc
zyp0921
2019-01-20 10:05:47 +08:00
redmin 上的 wiki
952764934
2019-01-20 10:35:25 +08:00
yapi
linmq
2019-01-20 10:41:52 +08:00
Swagger
FindHao
2019-01-20 11:17:34 +08:00
sphinx ？
FindHao
2019-01-20 11:18:21 +08:00
sphinx 对 markdown 的支持不太好，我测试的时候，会有这样那样的问题出现，最后决定用 rst
MrKou47
2019-01-20 12:07:33 +08:00
可用 slate
locoz
2019-01-20 12:09:02 +08:00
之前用一些工具写过感觉不够舒服，准备用 python 的那个 docstring 语法写，然后 web 框架启动的时候读它来生成。。
ooee2016
2019-01-20 13:26:01 +08:00
eolinker
loading
2019-01-20 13:54:25 +08:00
没人提 gitbook ？
zhuzhibin
2019-01-20 18:50:33 +08:00
@zyp0921 redmine 刚刚注册看了一下 感觉这像是团队协作类工具哦
zhuzhibin
2019-01-20 18:51:08 +08:00
@xiaomimei 谢谢朋友
zhuzhibin
2019-01-20 18:51:42 +08:00
@yiranHZT swg 可以拉代码下来搭自己服务器不 😎
zhuzhibin
2019-01-20 18:52:08 +08:00
@locoz 秀啊哥 教我爬爬数据呗🙃
cnbattle
2019-01-20 22:40:11 +08:00
apizza🌚
huruwo
2019-01-20 22:41:48 +08:00
javadoc ？
locoz
2019-01-20 23:17:50 +08:00
@zhuzhibin #15 我不是，我没有，别瞎说啊.jpg 菜鸡一个，教不了
endoffight
2019-01-21 11:07:07 +08:00
apidoc ？
zhuzhibin
2019-01-22 12:42:06 +08:00
@loading 已采用 gitbook 搭了一下

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/528740

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX