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

[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 配置

[jigi330]

挺好看的呀，回头试试

[balabalaguguji]

@feehey
@wzw
只支持一层目录结构，子参数也只有 2 层，编写体验不够好，每添加一行都要鼠标点击，预览不够优雅
不支持自定义参数块，比如我想在请求参数后面增加一个请求说明；在响应参数那里多添加一个失败情况的返回参数块，或者调整参数块的顺序，不够灵活，而这些易文档都支持。

[ericv]

postman 足够了。。。

[balabalaguguji]

@ericv postman 主要只做接口测试这块的，文档功能很差，我们是文档+测试+测试用例+mock 一体，写完文档可以直接测试，测试完可以直接保存作为 demo，服务端还没开发好接口还可以一键生成 mock 配置，不影响客户端开发

[wzw]

@balabalaguguji #22 那自动化测试 方面呢

[w516322644]

YAPI?

[balabalaguguji]

@wzw #25 这个还在排期开发中，后面会提供

[yixiang]

竞品太多，还都免费，不知能盈利否。

[balabalaguguji]

@yixiang #28 当初也是为了自己方便开发的，后面越做越好，就成了产品，说实话，我们现在做的体验是市面第一的，不怕竞争。

[laogui]

xyz 域名感觉是那种过几天就打不开的网站

[jabin88]

没感觉比其他竞品好，还收费

[chennqqi]

https://app.swaggerhub.com 个人用户免费，github 登录，可以公开可以私有，没发现比这个更好的；
楼主可以对照一下

[edsheeran]

@laogui abc.xyz

[balabalaguguji]

@chennqqi #32 这个我们对比过了，远没我们的好，我们的个人用户也是免费

[lqzhgood]

刚好做完一个个人项目~ 试用一下。
lz 加油哦

[lqzhgood]

接口描述 我感觉这样排列比较好~

是否必须 参数类型 参数名 描述

前面 2 个 宽度基本是一定的。 描述也许会很长。 这样比较对仗工整。

是否必须 使用 ( 是 /否 ) 或者 多选框的勾选 来显示。 比较干净。

[chennqqi]

@balabalaguguji are you sure?

听你说的比较好用，我专门注册登录试了一下你的产品。

给你们的产品提个建议:

接口文档的有个规范叫 openapi，目前是 3.x 版本，按照这个规范可以导出到多种开发语言
可以自动 mock

目前这块儿同类的有 RAML，blueprint 你们都可以对照一些。

根据我的经验在大厂环境下不支持 swagger/openapi 格式直接可以 pass 了

淘宝有这么一款开源产品 RAP 和 rap2 你可以了解一下

可以把同类产品和你的产品特性对比发出来看看哈。

希望你们越做越好，能把 swaggerhub 替代了，真不想再用 swaggerhub 了，国内访问奇慢无比，但就是没找到更好的。

[balabalaguguji]

@chennqqi #37 你说的规范，那都是数据的格式了，写个脚本转换下就可以了。但是对于用户来说，我们更需要关注编写是否便捷，是否快速，预览时是否够清晰明了。你说的那个是直接写注释的，那种方式很麻烦，代码也会被严重污染，特别是参数多、有多层级参数返回时，一大片都是注释，这种跟写 txt 的感觉是一样的，建议你体验下我们的编写方式，完全不是一个级别的。

[chennqqi]

话不投机，就此打住

[LeonKennedy]

歪个题，网站前端用什么做的，服务条款那个页面好漂亮啊，正好有需要拿来用了