前言
开发中,接口文档很重要,特别是现在web开发都开始前后端分离了,更加需要一个好的接口文档。
那要怎么快速的出接口文档、调用示例、mock呢?如果太麻烦,很多人就不愿意去写了。
今天给大家介绍一个非常方便的工具,易文档 https://easydoc.xyz
易文档是一个专业的接口管理平台,他可以轻松的写出专业漂亮的api文档,更重要的是可以一键生成接口文档、调用示例、mock配置,一举三成,轻松愉快。
先睹为快,在线看 预览效果
如何一键生成
开发完接口,我们通常都需要进行下接口测试,以便确定接口是ok的
易文档提供在线接口测试功能,关键是测试后,易文档可以根据你的请求和响应参数,一键生成接口文档,然后根据文档又可以一键生成mock配置,还可以把整个测试过程保存为一个调用示例。
这样接口测试完了,你的文档、示例、mock也都有了。
动图演示一键生成文档
一键生成文档动图演示生成调用示例
添加调用示例,可以让其他人更好的理解怎么调用接口。
你可以在接口测试后,把整个请求和响应参数存为一个调用示例
调用示例还可以方便测试人员保存各种情况的测试结果喔,比如手机号登录、验证码登录等不同调用,不同临界值都可以保存为一个调用示例
生成调用示例一键生成mock配置
服务端接口还没开发好,怎么办?只需要把接口文档写好,就可以一键生成mock配置啦,客户端就可以进行开发了,看下图
根据文档一键生成mock配置最后文档效果
下面是最后的文档预览效果,其中绿色的爬虫是表示调用示例,瓶子表示mock,在线看 预览效果
文档预览效果
网友评论