你还能找到比易文档更好用的接口文档工具吗？

[balabalaguguji]

想问下各位，你们平常开发都写 API 文档吗？我们团队协作平常都会写，大概这些情况会用到：

1. 远程协作，这种情况接口文档肯定是必须的；
2. 坐在一起开发，开发节奏不一致的，也需要写好接口文档给客户端，不然等他跟你对接时，你还得去翻代码，告诉他有些什么请求参数 /响应参数；
3. 接手别人的项目，你肯定会希望有个接口文档

写接口文档的工具，我尝试过很多，我之前用过txt写、用过小幺鸡、用过apizza、用过Showdoc、看云、Gitbook、ReadTheDoc、Yapi、MinDoc、eoLinker、RAR，真的是尝试过很多个，但是他们都有一些不如意的地方。

小幺鸡：样式太丑，直接是十几年前那种table的样式，每添加一行参数都要鼠标点击一下新建，编写体验很差，预览页面真的很丑，接口调试没成功过，也用过它的markdown、富文本，体验都好差

apizza：刚开始我以为终于找到一个靠谱的了，但是！响应参数文档在哪填写！！！？另外没有 markdown，没有不限层级目录结构、子参数，最后只能抛弃。

showdoc：这个是存粹写 markdown 的，虽然可以保存模板，但是用来写 api 文档真的还是太麻烦了，跟写 txt 一样，这种体验，作为懒惰的程序猿是无法忍受的。

有些人也推荐过我那种直接代码注释生成文档的，我认为这种做法，代码里面会有特别多的注释，你要有请求参数，还要有响应参数，有些参数还是字典类型的，要是层级多了，你根本就不知道怎么表达好，代码会非常丑陋，所以一个编写体方便，体验好，预览效果优雅的文档工具才是我最需要的。

个人认为，这类开发工具，只有真正的开发者做产品经理，才能做好，才能知道他们想要什么样的效果、功能

后面自己做了一个，算是我的创业项目，易文档 https://easydoc.xyz，我保证，你用过后，再也不会想用其他的，如果你能找到一个比我们更好的，请一定告诉我们。

作为程序猿的我们，比较追求极致的输入体验，不服的，可以看下 预览效果， 支持在线接口调试，存为测试用例，一键生成 mock 配置

[lyric]

demo 也要注册太过分了吧。

[woncode]

跟 swagger 比如何？

[dangyuluo]

几个链接都打不开
坐标 37°25'3X.X"N 122°07'2X.X"W

[wzw]

可以测试接口吗

[balabalaguguji]

@lyric #1 看 demo 不用注册的

[balabalaguguji]

@woncode #2 swagger 是写注释那种的，参数多了会很乱，污染代码，也无法写调用示例、markdown。预览效果也完全没有我们的好看

[balabalaguguji]

@wzw #4 接口测试可以，而且测完还可以保存你的结果（存为测试用例），更方便他人明白接口调用方法，也方便自己保存一些常用的调用结果，比如接口需要登陆后返回的 token，你可以把登陆结果存为测试用例，下次用时直接查看测试用例就知道 token 了

[andychen1]

apizza 大法好

[secsilm]

一直在找一个可以直接自动生成 api 文档的工具

[yogogo]

apiDoc

[balabalaguguji]

@andychen1 #8 你可以试下我们的，我有信心你不会再用其他的

[balabalaguguji]

@yogogo #10 这个好像是写注释的，不是很适合我，体验也远没我们的好

[x86]

先换个.com 吧...

[Spoter]

gitbook 不好用吗。。。

[balabalaguguji]

@Spoter #14 写 api 文档不适合

[feehey]

Yapi 真香

[balabalaguguji]

@x86 #13 google 也在用 xyz

[nzzzg]

页面挂了？ 进去是个空白页面

[wzw]

@feehey #16 同意

[balabalaguguji]

@nzzzg 什么浏览器，我们不支持 IE