解救开发人员写文档的痛苦

开发人员的痛苦

接手前人的项目，没有接口文档，只能看代码学习

接口文档用txt、word、markdown写，编写特别麻烦，写出来的文档也不美观。

多层级的参数（子参数），写起来麻烦，不知道怎么表达更好。

有的文档需要图文并茂，需要代码示例，需要测试用例，需要提供mock ...

常用参数需要重复写很多次，没有快速的引用的功能

写完接口，还需要自己写代码测试接口是否正确

前端需要等待服务端把接口写完后，才能进行联调开发

解决方案

使用专业的接口管理工具：易文档，集合API文档管理，接口在线测试，一键生成mock配置，测试用例

支持http、tcp、markdown、富文本多种文档格式

专门为http文档准备的编辑器，编写方便快速，不需要动鼠标，写完一个 tab 一下就下一个，全键盘操作

支持常用参数快捷引用，不再做无聊的重复工作；

支持预定义域名，快速切换测试服，正式服。

支持参数行顺序调整，拖动就能调整

可以随意增加 /删除参数块，比如我不需要头部参数，我可以删除；我可以添加成功时返回什么参数，失败时又返回什么参数

可以自定义说明，比如我想在请求参数后面添加一个特别说明，或者示例，我可以随时增减，并且随时调整顺序

可以在线测试接口，测试完还可以把调用结果保存为测试用例，方便他人查看和快速引用

漂亮专业的预览页，点击就能自动复制 url，参数名等

文档列表可以进行分类，调整顺序，搜索

可以随时分享文档给朋友，可以设置密码、失效时间

转载于:https://juejin.im/post/5c6a657551882562c85ad0de