写 api 文档的工具

2020-05-18 05:08:36 +08:00
 hwlhwlxyz
问一下有没有好用的写 api 文档的工具？就两个人写，感觉 swagger editor 写起来太复杂了。大家一般都用什么呢？
7531 次点击
所在节点    程序员
34 条回复
xsir
2020-05-18 07:26:28 +08:00
yapi
dullwit
2020-05-18 07:39:40 +08:00
https://github.com/slatedocs/slate
qinxiao
2020-05-18 08:25:02 +08:00
md 一把梭
LoNeFong
2020-05-18 08:45:05 +08:00
excel /狗头
ytmsdy
2020-05-18 08:46:01 +08:00
showdoc 吧，感觉用来写文档挺好用的。
hnbcinfo
2020-05-18 08:49:15 +08:00
YApi，然后项目里，自定义几个 Attribute，用在接口和 Dto 字段上，通过反射获取接口和参数信息，自动更新解析到 Yapi 。懒人必备，同时也省去了接口更新后忘了更新文档的麻烦。
balabalaguguji
2020-05-18 09:15:49 +08:00
易文档很好用，专门写接口文档的 https://easydoc.xyz

![preview.png]( https://i.loli.net/2020/05/18/MNR3yb1KOthnsuI.png)
lizz666
2020-05-18 09:28:03 +08:00
https://easydoc.xyz/
linauror
2020-05-18 10:20:33 +08:00
目前在用 markdown，感觉写起来自在一点
Rwing
2020-05-18 10:22:40 +08:00
相信我，如果不用一款自动生成文档的工具，那么没人愿意去”写“文档
putaozhenhaochi
2020-05-18 10:53:02 +08:00
Rap2
Elephant696
2020-05-18 11:07:45 +08:00
/mar/kdown
Xezzon
2020-05-18 11:16:04 +08:00
在线 NEI，本地部署 YApi 。
shuang
2020-05-18 11:23:48 +08:00
不推荐 Rap2
强烈推荐 YApi
thet
2020-05-18 12:48:55 +08:00
之前用 eolinker 在线的，还可以
Heanes
2020-05-18 15:21:25 +08:00
yapi，或者注解自动生成
anaf
2020-05-18 15:23:52 +08:00
sphinx-doc
5G
2020-05-18 15:31:06 +08:00
自己造轮子 ing
aaaafei
2020-05-18 15:52:58 +08:00
还没试过 yapi，试过易文档，感觉还可以
narmgalaxy
2020-05-18 15:59:13 +08:00
YApi

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

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

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

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

© 2021 V2EX