写 api 文档的工具

[hwlhwlxyz]

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

[xsir]

yapi

[dullwit]

https://github.com/slatedocs/slate

[qinxiao]

md 一把梭

[LoNeFong]

excel /狗头

[ytmsdy]

showdoc 吧，感觉用来写文档挺好用的。

[hnbcinfo]

YApi，然后项目里，自定义几个 Attribute，用在接口和 Dto 字段上，通过反射获取接口和参数信息，自动更新解析到 Yapi 。懒人必备，同时也省去了接口更新后忘了更新文档的麻烦。

[balabalaguguji]

易文档很好用，专门写接口文档的 https://easydoc.xyz


[lizz666]

https://easydoc.xyz/

[linauror]

目前在用 markdown，感觉写起来自在一点

[Rwing]

相信我，如果不用一款自动生成文档的工具，那么没人愿意去”写“文档

[putaozhenhaochi]

Rap2

[Elephant696]

/mar/kdown

[Xezzon]

在线 NEI，本地部署 YApi 。

[shuang]

不推荐 Rap2
强烈推荐 YApi

[thet]

之前用 eolinker 在线的，还可以

[Heanes]

yapi，或者注解自动生成

[anaf]

sphinx-doc

[5G]

自己造轮子 ing

[aaaafei]

还没试过 yapi，试过易文档，感觉还可以

[narmgalaxy]

YApi

[mylxsw]

写 API 文档可以在代码中使用 Swagger 来生成，一般语言都有相关的库可以使用，嫌麻烦可以直接使用 Markdown 来写。

推荐 Wizard，仓库地址 https://github.com/mylxsw/wizard，同时支持 Markdown 和 Swagger 两种类型的文档。

[blackhumorly]

Yapi

[hantsy]

asciidoc

[ChoateYao]

推荐 RAP2 的都是没有深度使用的，就 RAP2 这种一次性加载几 M 数据十秒+的软件也能拿出来吹

[fanyingmao]

我之前是用 apidoc 比较轻量级，写在注释中

[catoncat]

https://insomnia.rest/

[yutonliu]

showdoc

[qile1]

@yutonliu
@ytmsdy 这个现在需要手机注册验证了，之前 qq 登录没问题，写了一堆文档，突然有一天让验证手机了，连缓存都没有！

已经放弃

[Xusually]

@qile1 自己部署私有的就行了。

[hwlhwlxyz]

手写 markdown 也是可以，就是有的时候翻起来比较麻烦点。Yapi 看起来好强大啊，我去试试看。

[hwlhwlxyz]

看了下，就两个人的话，showdoc 也挺好用，还好项目不大的。谢谢大家的回复。

[iacker]

语雀，用后你会回来感谢我的～

[cz5424]

yapi 不能生成对外的文档..

[star7th]

@qile1 showdoc 没有强制手机验证，也没有 qq 登录。我觉得你是不是误解了。其官网地址是这个 www.showdoc.cc ，其他的地址都是别人部署给自用的私有版。