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

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 2565 天前的主题，其中的信息可能已经有所发展或是发生改变。

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

文档

Markdown

API

插件

20 条回复 • 2019-01-22 12:42:06 +08:00

xiaomimei

2019 年 1 月 20 日 via Android

https://swagger.io/tools/swagger-editor/

Everyman

2019 年 1 月 20 日

后端 swagger、前端 JSDoc

zyp0921

2019 年 1 月 20 日

redmin 上的 wiki

952764934

2019 年 1 月 20 日

yapi

linmq

2019 年 1 月 20 日 via iPhone

Swagger

FindHao

2019 年 1 月 20 日 via Android

sphinx ？

FindHao

2019 年 1 月 20 日 via Android

sphinx 对 markdown 的支持不太好，我测试的时候，会有这样那样的问题出现，最后决定用 rst

MrKou47

2019 年 1 月 20 日 via iPhone

可用 slate

locoz

2019 年 1 月 20 日 via Android

之前用一些工具写过感觉不够舒服，准备用 python 的那个 docstring 语法写，然后 web 框架启动的时候读它来生成。。

ooee2016

2019 年 1 月 20 日 via iPhone

eolinker

loading

2019 年 1 月 20 日 via Android

没人提 gitbook ？

zhuzhibin

2019 年 1 月 20 日 via iPhone

@zyp0921 redmine 刚刚注册看了一下感觉这像是团队协作类工具哦

zhuzhibin

2019 年 1 月 20 日 via iPhone

@xiaomimei 谢谢朋友

zhuzhibin

2019 年 1 月 20 日 via iPhone

@yiranHZT swg 可以拉代码下来搭自己服务器不 😎

zhuzhibin

2019 年 1 月 20 日 via iPhone

@locoz 秀啊哥教我爬爬数据呗🙃

cnbattle

2019 年 1 月 20 日 via Android

apizza🌚

huruwo

2019 年 1 月 20 日 via Android

javadoc ？

locoz

2019 年 1 月 20 日 via Android

@zhuzhibin #15 我不是，我没有，别瞎说啊.jpg 菜鸡一个，教不了

endoffight

2019 年 1 月 21 日

apidoc ？

zhuzhibin

2019 年 1 月 22 日 via iPhone

@loading 已采用 gitbook 搭了一下