问一下有没有好用的写 api 文档的工具?就两个人写,感觉 swagger editor 写起来太复杂了。大家一般都用什么呢?

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