V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX  ›  NicholasHsiang  ›  全部回复第 1 页 / 共 1 页
回复总数  1
2020-01-11 14:24:54 +08:00
回复了 balabalaguguji 创建的主题 分享创造 你还能找到比易文档更好用的接口文档工具吗?
支持易文档。手头一个项目( apizza → yapi → easydoc ):

- apizza,

好的地方:有“全局状态码”,
不好的地方太多,UI 根本不行,另外最大问题,从数据库字段生成 JSON,导入报错 JSON 格式错误,让人怀疑…果断放弃!

- yapi

好的地方:
0、开源!开源!开源!
1、导入 JSON 杠杠的,能检测 JSON 是否合法,
2、加 Mock 很方便,
3、参数“高级设置”中,加限制条件极其方便,
4、“预览”超级好,尤其是前端可以直接用生成的结构,
5、编辑参数时,加节点方便,
6、请求参数设置很方便,
7、有是否完成状态,
8、UI 非常好,限定的非常好。
9、导出超级好用,

不好的地方:
1、不能将常用字段做成模板,非常不好
2、不能复制参数字段到粘贴板,
3、接口列表中拖动调整顺序难用

- easydoc

好的地方
1、能将常用字段做成模板,并且可以编辑,太好用!太好用!太好用!
2、接口列表中拖动调整顺序好用,
3、预览模式中能复制参数字段到粘贴板
4、导入 JSON 杠杠的
不好的地方
1、Mock 难用,
2、想开选项卡,打开多了选项卡,…
3、“添加参数块”,过于灵活,Response、Request * Header、Body 不就好了?
4、没有完成与否的选项,不知道进度到哪


使用之后评论:

对比下来,easydoc “能将常用字段做成模板” 这个功能是出 API 文档时的硬需求,除了这点,完全可以选择开源的 yapi。
关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3427 人在线   最高记录 6679   ·     Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 9ms · UTC 11:21 · PVG 19:21 · LAX 03:21 · JFK 06:21
Developed with CodeLauncher
♥ Do have faith in what you're doing.