VirAPI 接口文档导出功能上线,可分享并离线查看接口文档啦!

2020年10月12日

VirAPI -- 非侵入式在线虚拟数据请求返回接口,可视化创建丰富多样的数据格式,请求即可得你所需要的响应数据。

在我们的开发过程中,前后端对接总少不了接口文档。前端同学不需要了解后端的逻辑,只需要后端接口的输入输出规则,然后按照这些规则提交数据即可。接口文档就是这中间的“交流语言”,其重要是毋庸置疑且必不可少的。

为此,为了方便离线查阅接口文档,同时为了满足接口的对接与交流,VirAPI在此次版本更新中特将导出接口文档功能为大家呈上。

登录VirAPI控制台,找到目标应用并点击进入,在左侧的菜单栏里选择【管理】,即可看见新加的【导出接口文档】功能入口。点击进入页面,然后点击【导出接口文档】功能按钮即可导出接口文档了。

导出接口文档示意截图

导出的接口文档主要包括当前应用基本信息及当前接口下所有接口信息。注意:当前接口文档暂仅支持导出Markdown格式文本。

  • 应用的基本信息:如应用名、应用slug、应用编号、应用权限验证方式、应用描述、创建及更新时间、接口总数...
  • 应用所有接口信息:如接口名、接口描述、接口请求URL、请求方式、请求参数、响应结构等。

应用接口文档内容可参考下方截图:

VirAPI接口文档示意截图

以上就是该次的版本更新内容,希望能对你有所帮助。

展开阅读全文
14 收藏
分享
加载中
最新评论 (2)
非常实用
2020-10-15 15:46
0
回复
举报
😊感谢支持,平台还在继续完善中,有好的建议或反馈也欢迎交流
2020-10-17 11:12
0
回复
举报
更多评论
2 评论
14 收藏
分享
返回顶部
顶部