这是一个创建于 1653 天前的主题，其中的信息可能已经有所发展或是发生改变。
问一下有没有好用的写 api 文档的工具？就两个人写，感觉 swagger editor 写起来太复杂了。大家一般都用什么呢？
 |
1
xsir 2020-05-18 07:26:28 +08:00
yapi
|
 |
2
dullwit 2020-05-18 07:39:40 +08:00 via iPhone
|
 |
3
qinxiao 2020-05-18 08:25:02 +08:00
md 一把梭
|
 |
4
LoNeFong 2020-05-18 08:45:05 +08:00 via Android
excel /狗头
|
 |
5
ytmsdy 2020-05-18 08:46:01 +08:00
showdoc 吧，感觉用来写文档挺好用的。
|
 |
6
hnbcinfo 2020-05-18 08:49:15 +08:00
YApi，然后项目里，自定义几个 Attribute，用在接口和 Dto 字段上，通过反射获取接口和参数信息，自动更新解析到 Yapi 。懒人必备，同时也省去了接口更新后忘了更新文档的麻烦。
|
 |
7
balabalaguguji 2020-05-18 09:15:49 +08:00
易文档很好用，专门写接口文档的 https://easydoc.xyz
 |
 |
8
lizz666 2020-05-18 09:28:03 +08:00
|
 |
9
linauror 2020-05-18 10:20:33 +08:00
目前在用 markdown，感觉写起来自在一点
|
 |
10
Rwing 2020-05-18 10:22:40 +08:00  1
相信我，如果不用一款自动生成文档的工具，那么没人愿意去”写“文档
|
 |
11
putaozhenhaochi 2020-05-18 10:53:02 +08:00 via Android
Rap2
|
 |
12
Elephant696 2020-05-18 11:07:45 +08:00
/mar/kdown
|
 |
13
Xezzon 2020-05-18 11:16:04 +08:00 via Android
在线 NEI，本地部署 YApi 。
|
 |
14
shuang 2020-05-18 11:23:48 +08:00
不推荐 Rap2
强烈推荐 YApi |
 |
15
thet 2020-05-18 12:48:55 +08:00 via iPhone
之前用 eolinker 在线的，还可以
|
 |
16
Heanes 2020-05-18 15:21:25 +08:00
yapi，或者注解自动生成
|
 |
17
anaf 2020-05-18 15:23:52 +08:00
sphinx-doc
|
 |
18
5G 2020-05-18 15:31:06 +08:00
自己造轮子 ing
|
 |
19
aaaafei 2020-05-18 15:52:58 +08:00
还没试过 yapi，试过易文档，感觉还可以
|
 |
20
narmgalaxy 2020-05-18 15:59:13 +08:00
YApi
|
 |
21
mylxsw 2020-05-18 16:31:45 +08:00
写 API 文档可以在代码中使用 Swagger 来生成，一般语言都有相关的库可以使用，嫌麻烦可以直接使用 Markdown 来写。
推荐 Wizard，仓库地址 https://github.com/mylxsw/wizard，同时支持 Markdown 和 Swagger 两种类型的文档。 |
 |
22
blackhumorly 2020-05-18 16:32:44 +08:00
Yapi
|
 |
23
hantsy 2020-05-18 16:39:12 +08:00
asciidoc
|
 |
24
ChoateYao 2020-05-18 16:49:52 +08:00
推荐 RAP2 的都是没有深度使用的，就 RAP2 这种一次性加载几 M 数据十秒+的软件也能拿出来吹
|
 |
25
fanyingmao 2020-05-18 17:24:30 +08:00
我之前是用 apidoc 比较轻量级，写在注释中
|
 |
26
crs0910 2020-05-18 17:28:55 +08:00
https://insomnia.rest/
|
 |
27
yutonliu 2020-05-18 18:28:22 +08:00
showdoc
|
 |
28
qile1 2020-05-18 19:16:55 +08:00 via Android
|
 |
30
hwlhwlxyz OP 手写 markdown 也是可以，就是有的时候翻起来比较麻烦点。Yapi 看起来好强大啊，我去试试看。
|
|
31
hwlhwlxyz OP 看了下，就两个人的话，showdoc 也挺好用，还好项目不大的。谢谢大家的回复。
|
 |
32
iacker 2020-05-18 23:16:17 +08:00 via iPhone
语雀，用后你会回来感谢我的～
|
 |
33
cz5424 2020-05-19 12:03:24 +08:00
yapi 不能生成对外的文档..
|
 |
34
star7th 2020-05-21 09:26:23 +08:00
@qile1 showdoc 没有强制手机验证，也没有 qq 登录。我觉得你是不是误解了。其官网地址是这个 www.showdoc.cc ，其他的地址都是别人部署给自用的私有版。
|
Select Language